技能 编程开发 构建最小API与OpenAPI文档

构建最小API与OpenAPI文档

v20260410
aspnet-minimal-api-openapi
本指南教授如何构建结构良好、功能健壮的ASP.NET Minimal API。内容涵盖API的最佳组织实践、定义包含校验的DTO模型、处理强类型参数,并重点演示如何利用.NET内置功能生成全面且标准的OpenAPI/Swagger文档,确保API易于理解和调用。
获取技能
161 次下载
概览

ASP.NET Minimal API with OpenAPI

Your goal is to help me create well-structured ASP.NET Minimal API endpoints with correct types and comprehensive OpenAPI/Swagger documentation.

API Organization

  • Group related endpoints using MapGroup() extension
  • Use endpoint filters for cross-cutting concerns
  • Structure larger APIs with separate endpoint classes
  • Consider using a feature-based folder structure for complex APIs

Request and Response Types

  • Define explicit request and response DTOs/models
  • Create clear model classes with proper validation attributes
  • Use record types for immutable request/response objects
  • Use meaningful property names that align with API design standards
  • Apply [Required] and other validation attributes to enforce constraints
  • Use the ProblemDetailsService and StatusCodePages to get standard error responses

Type Handling

  • Use strongly-typed route parameters with explicit type binding
  • Use Results<T1, T2> to represent multiple response types
  • Return TypedResults instead of Results for strongly-typed responses
  • Leverage C# 10+ features like nullable annotations and init-only properties

OpenAPI Documentation

  • Use the built-in OpenAPI document support added in .NET 9
  • Define operation summary and description
  • Add operationIds using the WithName extension method
  • Add descriptions to properties and parameters with [Description()]
  • Set proper content types for requests and responses
  • Use document transformers to add elements like servers, tags, and security schemes
  • Use schema transformers to apply customizations to OpenAPI schemas
信息
Category 编程开发
Name aspnet-minimal-api-openapi
版本 v20260410
大小 1.71KB
更新时间 2026-04-12
语言