api-documentation

Automate OpenAPI/Swagger documentation for .NET Minimal API endpoints.

Updated Mar 28, 2026

Search Tags:#documentation #openapi #dotnet #swagger #minimal-api #endpoint-metadata

Ready to run

npx skills add https://github.com/congiuluc/my-awesome-copilot --skill api-documentation-congiuluc

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/congiuluc/my-awesome-copilot/tree/main/skills/api-documentation
Command: npx skills add https://github.com/congiuluc/my-awesome-copilot --skill api-documentation-congiuluc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Configures and maintains Swagger/OpenAPI documentation for .NET Minimal API endpoints, ensuring consistent endpoint metadata, schemas, and UI integration.

Core Features & Use Cases

Register OpenAPI services in Program.cs and enable environment-specific Swagger UI.
Annotate endpoints with WithName, WithSummary, WithDescription, and group with WithTags for clear API contracts.
Document request/response models with XML comments and a standard ApiResponse envelope to unify schemas.

Quick Start

Frequently Asked Questions about api-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I document .NET Minimal API endpoints with OpenAPI?▼

Swagger documentation for .NET Minimal APIs requires endpoints to bear WithName, WithSummary, and Produces annotations, grouped with WithTags, while OpenAPI services are registered in Program.cs to generate standard contracts and UI.

What is the standard way to configure Swagger UI in a .NET Minimal API?▼

Configuring Swagger UI involves registering OpenAPI services in Program.cs and enabling environment-specific UI rendering, which relies on endpoints bearing WithName, WithSummary, and Produces annotations for clear API contracts.

How do I unify request and response schemas for .NET Minimal API documentation?▼

To unify request and response schemas for .NET Minimal API documentation, you document models with XML comments and use a standard ApiResponse envelope, ensuring endpoints have WithName, WithSummary, and Produces annotations.

Does .NET Minimal API require endpoint metadata for OpenAPI generation?▼

Yes, .NET Minimal APIs require endpoint metadata like WithName, WithSummary, and Produces annotations grouped by WithTags to properly generate OpenAPI documentation and standardize API contracts in Program.cs.

When should I configure environment-specific Swagger UI in .NET APIs?▼

Environment-specific Swagger UI is configured during API development and maintenance to safely visualize endpoint metadata, request/response schemas, and OpenAPI behavior without exposing the documentation interface in production.

Why are my .NET Minimal API endpoints missing from the Swagger UI?▼

Endpoints missing from Swagger UI typically lack required WithName, WithSummary, and Produces annotations, or OpenAPI services are not registered in Program.cs, preventing proper endpoint metadata and schema rendering.