ln-722-backend-generator

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

ln-722-backend-generator

Type: L3 Worker Category: 7XX Project Bootstrap Parent: ln-720-structure-migrator

Generates complete .NET backend structure following Clean Architecture principles.

类型： L3 Worker 分类： 7XX 项目初始化 父级： ln-720-structure-migrator

遵循Clean Architecture原则生成完整的.NET后端结构。

Purpose & Scope

目的与范围

Aspect	Description
Input	Project name, entity list, configuration options
Output	Complete .NET solution with layered architecture
Target	.NET 10+, ASP.NET Core

Scope boundaries:

Generates project structure and boilerplate code
Creates MockData for initial development
Does not implement business logic or database connections

方面	描述
输入	项目名称、实体列表、配置选项
输出	具有分层架构的完整.NET解决方案
目标框架	.NET 10+、ASP.NET Core

范围边界：

生成项目结构和样板代码
创建用于初始开发的MockData
不实现业务逻辑或数据库连接

Workflow

工作流程

Phase	Name	Actions	Output
1	Receive Context	Get project name, entities, options from coordinator	Configuration
2	Create Solution	Create .sln and .csproj files	Empty solution structure
3	Generate Domain	Create entities, enums, base classes	Domain project files
4	Generate API	Create controllers, DTOs, middleware	API project files
5	Verify	Build solution, check references	Build success

阶段	名称	操作	输出
1	接收上下文	从协调器获取项目名称、实体和选项	配置信息
2	创建解决方案	创建.sln和.csproj文件	空解决方案结构
3	生成领域层	创建实体、枚举、基类	领域层项目文件
4	生成API层	创建控制器、DTO、中间件	API层项目文件
5	验证	构建解决方案，检查引用	构建成功

Phase 1: Receive Context

阶段1：接收上下文

Accept delegation from ln-720-structure-migrator.

Input	Type	Required	Description
`projectName`	string	Yes	Solution and project name prefix
`targetPath`	string	Yes	Directory for generated solution
`targetFramework`	string	Yes	.NET version (e.g., net10.0)
`entities`	list	Yes	Entity names to generate
`features`	list	Yes	Feature groupings for MockData

Options:

Option	Default	Effect
`useSwagger`	true	Add Swashbuckle for API docs
`useSerilog`	true	Add structured logging
`useHealthChecks`	true	Add health endpoints
`createMockData`	true	Generate mock data classes

接受来自ln-720-structure-migrator的委托。

输入	类型	是否必填	描述
`projectName`	string	是	解决方案和项目名称前缀
`targetPath`	string	是	生成解决方案的目录
`targetFramework`	string	是	.NET版本（例如：net10.0）
`entities`	list	是	要生成的实体名称
`features`	list	是	MockData的功能分组

选项：

选项	默认值	作用
`useSwagger`	true	添加Swashbuckle用于API文档
`useSerilog`	true	添加结构化日志
`useHealthChecks`	true	添加健康检查端点
`createMockData`	true	生成模拟数据类

Phase 2: Create Solution

阶段2：创建解决方案

Generate solution file and project structure.

Step	Action	Reference
2.1	Create solution directory	—
2.2	Generate .sln file	—
2.3	Create project directories	`layer_structure.md`
2.4	Generate .csproj files per layer	`layer_structure.md`
2.5	Add project references	`layer_structure.md`

Generated projects:

Project	Purpose
`{Project}.Api`	HTTP endpoints, middleware
`{Project}.Domain`	Entities, enums
`{Project}.Services`	Business logic interfaces
`{Project}.Repositories`	Data access interfaces
`{Project}.Shared`	Cross-cutting utilities

生成解决方案文件和项目结构。

步骤	操作	参考
2.1	创建解决方案目录	—
2.2	生成.sln文件	—
2.3	创建项目目录	`layer_structure.md`
2.4	为每个层生成.csproj文件	`layer_structure.md`
2.5	添加项目引用	`layer_structure.md`

生成的项目：

项目	用途
`{Project}.Api`	HTTP端点、中间件
`{Project}.Domain`	实体、枚举
`{Project}.Services`	业务逻辑接口
`{Project}.Repositories`	数据访问接口
`{Project}.Shared`	横切关注点工具类

Phase 3: Generate Domain

阶段3：生成领域层

Create domain layer files.

Step	Action	Reference
3.1	Create `BaseEntity` class	`entity_patterns.md`
3.2	Generate entity classes per input	`entity_patterns.md`
3.3	Generate status enums	`entity_patterns.md`
3.4	Create folder structure	`layer_structure.md`

Entity generation rules:

Entity Property	Generated As
Primary key	`public Guid Id { get; set; }`
String field	`public string Name { get; set; } = string.Empty;`
Status field	`public {Entity}Status Status { get; set; }`
Timestamps	`CreatedAt` , `UpdatedAt` from BaseEntity

创建领域层文件。

步骤	操作	参考
3.1	创建 `BaseEntity` 类	`entity_patterns.md`
3.2	根据输入生成实体类	`entity_patterns.md`
3.3	生成状态枚举	`entity_patterns.md`
3.4	创建文件夹结构	`layer_structure.md`

实体生成规则：

实体属性	生成格式
主键	`public Guid Id { get; set; }`
字符串字段	`public string Name { get; set; } = string.Empty;`
状态字段	`public {Entity}Status Status { get; set; }`
时间戳	来自BaseEntity的 `CreatedAt` 、 `UpdatedAt`

Phase 4: Generate API

阶段4：生成API层

Create API layer files.

Step	Action	Reference
4.1	Generate Program.cs	`program_sections.md`
4.2	Generate controllers per entity	`controller_patterns.md`
4.3	Generate DTOs per entity	`controller_patterns.md`
4.4	Generate middleware classes	`layer_structure.md`
4.5	Generate extension methods	`program_sections.md`
4.6	Generate MockData classes (if enabled)	`layer_structure.md`
4.7	Add NuGet packages	`nuget_packages.md`

Controller endpoints per entity:

Endpoint	Method	Route
GetAll	GET	`/api/{entities}`
GetById	GET	`/api/{entities}/{id}`
Create	POST	`/api/{entities}`
Update	PUT	`/api/{entities}/{id}`
Delete	DELETE	`/api/{entities}/{id}`

创建API层文件。

步骤	操作	参考
4.1	生成Program.cs	`program_sections.md`
4.2	为每个实体生成控制器	`controller_patterns.md`
4.3	为每个实体生成DTO	`controller_patterns.md`
4.4	生成中间件类	`layer_structure.md`
4.5	生成扩展方法	`program_sections.md`
4.6	生成MockData类（如果启用）	`layer_structure.md`
4.7	添加NuGet包	`nuget_packages.md`

每个实体对应的控制器端点：

端点	请求方法	路由
GetAll	GET	`/api/{entities}`
GetById	GET	`/api/{entities}/{id}`
Create	POST	`/api/{entities}`
Update	PUT	`/api/{entities}/{id}`
Delete	DELETE	`/api/{entities}/{id}`

Phase 5: Verify

阶段5：验证

Validate generated solution.

Check	Command	Expected
Solution builds	`dotnet build`	Success, no errors
Project references	Check .csproj	All references valid
Files created	Directory listing	All expected files present

验证生成的解决方案。

检查项	命令	预期结果
解决方案构建	`dotnet build`	成功，无错误
项目引用	检查.csproj文件	所有引用有效
文件创建	目录列表	所有预期文件已存在

Generated Structure Summary

生成结构摘要

Layer	Folders	Files per Entity
Api	Controllers/, DTOs/, Middleware/, MockData/, Extensions/	Controller, DTO
Domain	Entities/, Enums/, Common/	Entity, Status enum
Services	Interfaces/	Interface (stub)
Repositories	Interfaces/	Interface (stub)
Shared	—	Utility classes

层级	文件夹	每个实体对应的文件
Api	Controllers/、DTOs/、Middleware/、MockData/、Extensions/	控制器、DTO
Domain	Entities/、Enums/、Common/	实体、状态枚举
Services	Interfaces/	接口（存根）
Repositories	Interfaces/	接口（存根）
Shared	—	工具类

Critical Rules

关键规则

Single Responsibility: Generate only backend structure, no frontend
Idempotent: Can re-run to regenerate (will overwrite)
Build Verification: Must verify
```
dotnet build
```
passes
Clean Architecture: Respect layer dependencies (inner layers independent)
No Business Logic: Generate structure only, not implementation
MockData First: Enable immediate API testing without database

单一职责： 仅生成后端结构，不涉及前端
幂等性： 可重新运行以重新生成（会覆盖现有内容）
构建验证： 必须确保
```
dotnet build
```
执行通过
Clean Architecture： 遵循层级依赖关系（内层独立）
无业务逻辑： 仅生成结构，不实现具体功能
优先MockData： 支持无需数据库即可立即进行API测试

Definition of Done

完成标准

Solution file created with all projects
All project references configured correctly
Domain entities generated for all input entities
Controllers generated with CRUD endpoints
DTOs generated for request/response
MockData classes generated (if enabled)
Program.cs configured with all services
```
dotnet build
```
passes successfully
Swagger UI accessible (if enabled)

创建包含所有项目的解决方案文件
所有项目引用配置正确
为所有输入实体生成领域实体
生成带有CRUD端点的控制器
为请求/响应生成DTO
生成MockData类（如果启用）
Program.cs已配置所有服务
```
dotnet build
```
执行成功
Swagger UI可访问（如果启用）

Risk Mitigation

风险缓解

Risk	Detection	Mitigation
Build failure	`dotnet build` fails	Check .csproj references, verify SDK version
Missing references	CS0246 errors	Add missing project references
Invalid entity names	Build or runtime errors	Validate entity names before generation
Path conflicts	File exists errors	Check target path, prompt before overwrite
Package restore failure	NuGet errors	Verify network, check package names

风险	检测方式	缓解措施
构建失败	`dotnet build` 执行失败	检查.csproj引用，验证SDK版本
缺少引用	CS0246错误	添加缺失的项目引用
无效实体名称	构建或运行时错误	在生成前验证实体名称
路径冲突	文件已存在错误	检查目标路径，覆盖前提示
NuGet包还原失败	NuGet错误	验证网络连接，检查包名称

Reference Files

参考文件

File	Purpose
`references/layer_structure.md`	Project organization, folder structure, dependencies
`references/entity_patterns.md`	Entity generation rules, property patterns
`references/controller_patterns.md`	Controller and DTO generation rules
`references/program_sections.md`	Program.cs structure and service registration
`references/nuget_packages.md`	Required and optional NuGet packages

Version: 2.0.0 Last Updated: 2026-01-10

文件	用途
`references/layer_structure.md`	项目组织、文件夹结构、依赖关系
`references/entity_patterns.md`	实体生成规则、属性模式
`references/controller_patterns.md`	控制器和DTO生成规则
`references/program_sections.md`	Program.cs结构和服务注册
`references/nuget_packages.md`	必填和可选的NuGet包

版本： 2.0.0 最后更新： 2026-01-10