Catalog
github/aspnet-minimal-api-openapi

github

aspnet-minimal-api-openapi

Create ASP.NET Minimal API endpoints with proper OpenAPI documentation

global
New~425
v1.0Saved Jun 26, 2026

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
Files1
1 files · 1.0 KB

Select a file to preview

Overall Score

62/100

Grade

C

Adequate

Safety

88

Quality

55

Clarity

68

Completeness

48

Summary

A skill that guides creation of ASP.NET Minimal API endpoints with OpenAPI/Swagger documentation. It teaches best practices for endpoint organization, type safety, request/response modeling, and OpenAPI schema generation using .NET 9+ features. The skill provides structural patterns and documentation standards but lacks concrete code examples and implementation details.

Detected Capabilities

code generation guidancedocumentation standardstype system patternsschema transformation

Trigger Keywords

Phrases that MCP clients use to match this skill to user intent.

minimal api endpointsopenapi documentationaspnet swaggerc# dto designtyped responses

Use Cases

  • .NET Minimal API endpoint creation
  • OpenAPI schema documentation for ASP.NET APIs
  • Request/response type design and validation
  • Endpoint organization with MapGroup
  • API error handling with ProblemDetailsService
  • Strongly-typed response patterns in C#

Quality Notes

  • Skill provides useful high-level patterns but lacks concrete code examples; an agent would struggle to implement without samples
  • No error handling guidance or edge cases mentioned (null validation, timeout handling, large payloads)
  • Missing configuration examples for document and schema transformers
  • Does not explain how to set up ASP.NET 9 project or enable OpenAPI features
  • No mention of dependency versions, breaking changes, or compatibility with older .NET versions
  • Validation attributes mentioned but no examples of how to apply them or handle validation errors
  • ProblemDetailsService reference is vague — unclear how to configure or use it in the context of minimal APIs
Model: claude-haiku-4-5-20251001Analyzed: Jun 26, 2026

Reviews

Add this skill to your library to leave a review.

No reviews yet

Be the first to share your experience.

Add github/aspnet-minimal-api-openapi to your library

Command Palette

Search for a command to run...