aspnet-minimal-api-openapi

작성자: github

ASP.NET Minimal API 엔드포인트에 자동 OpenAPI/Swagger 문서화와 강력한 타입 지정을 제공합니다. MapGroup(), 엔드포인트 필터, 기능 기반 폴더 구조를 사용하여 엔드포인트를 구성하고 확장성을 확보합니다. 유효성 검사 속성이 포함된 명시적 요청/응답 DTO를 정의하고, record 타입과 TypedResults를 사용하여 타입 안전성을 보장합니다. .NET 9의 내장 OpenAPI 지원을 활용하여 작업 요약, 설명, operationId, [Description()]을 통한 속성 수준 문서화를 적용합니다. 문서 및 스키마...

npx skills add https://github.com/github/awesome-copilot --skill aspnet-minimal-api-openapi

ZIP 다운로드 GitHub

39.4k

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