---
id: ssh-aspnet-minimal-api-openapi
name: "aspnet-minimal-api-openapi"
url: https://skills.yangsir.net/skill/ssh-aspnet-minimal-api-openapi
author: github
domain: ai-backend-engineering
tags: ["asp.net-core-minimal-apis", "openapi-specification", "swagger-ui", "rest-api-development"]
install_count: 8600
rating: 4.50 (292 reviews)
github: https://github.com/github/awesome-copilot
---

# aspnet-minimal-api-openapi

> 创建带有适当OpenAPI文档的ASP.NET Minimal API端点，确保接口清晰。

**Stats**: 8,600 installs · 4.5/5 (292 reviews)

## Before / After 对比

### 创建带OpenAPI文档的Minimal API，接口清晰

## Readme

# 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


---
*Source: https://skills.yangsir.net/skill/ssh-aspnet-minimal-api-openapi*
*Markdown mirror: https://skills.yangsir.net/api/skill/ssh-aspnet-minimal-api-openapi/markdown*