用途:帮助创建结构良好、类型正确且具备完整 OpenAPI/Swagger 文档的 ASP.NET Minimal API 端点。
主要能力与组织方式:用 MapGroup() 扩展对相关端点分组;用端点过滤器处理横切关注点;较大 API 拆分为独立端点类;复杂 API 可采用基于功能的文件夹结构。
请求与响应类型:定义显式的请求和响应 DTO/模型;创建带验证特性的清晰模型类;对不可变请求/响应对象使用 record 类型;属性命名符合 API 设计规范;用 [Required] 等验证特性约束;用 ProblemDetailsService 和 StatusCodePages 获得标准错误响应。
类型处理:使用强类型路由参数与显式类型绑定;用 Results<T1, T2> 表示多种响应类型;返回 TypedResults 而非 Results 以获得强类型响应;利用 C# 10+ 的可空注解和 init-only 属性。
OpenAPI 文档:使用 .NET 9 内置的 OpenAPI 文档支持;定义操作摘要与描述;用 WithName 扩展方法添加 operationId;用 [Description()] 为属性和参数添加描述;为请求和响应设置正确的内容类型;用文档转换器添加服务器、标签和安全方案等元素;用架构转换器自定义 OpenAPI 架构。
适用场景:构建或重构 ASP.NET Minimal API 项目,尤其是需要规范 OpenAPI 文档、清晰 DTO 与强类型响应的场景。
限制:资料未提供具体安装命令、依赖版本、代码示例或收费信息,暂未提供。