dotnet-openapi

Generate OpenAPI documentation for ASP.NET Core applications using Microsoft.AspNetCore.OpenApi and NSwag.

71|10|Updated Feb 11, 2026
One-click install
npx skills add https://github.com/wshaddix/dotnet-skills --skill dotnet-openapi-wshaddix
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-openapi
Source: https://github.com/wshaddix/dotnet-skills/tree/main/skills/dotnet-openapi
Command: npx skills add https://github.com/wshaddix/dotnet-skills --skill dotnet-openapi-wshaddix

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies the process of generating and managing OpenAPI (Swagger) documentation for ASP.NET Core applications, ensuring your APIs are well-documented and discoverable.

Core Features & Use Cases

  • First-party OpenAPI Generation: Utilizes Microsoft.AspNetCore.OpenApi for modern .NET applications (.NET 9+).
  • Swashbuckle Migration Guidance: Provides clear steps to migrate from the legacy Swashbuckle.AspNetCore.
  • NSwag Integration: Supports NSwag for advanced scenarios like client generation.
  • Customization: Allows for document and operation transformations to enrich OpenAPI metadata.
  • Use Case: You've built a new ASP.NET Core Web API and need to generate an OpenAPI specification so that frontend developers can easily understand and consume your endpoints.

Quick Start

Use the dotnet-openapi skill to set up basic OpenAPI documentation for an ASP.NET Core application.

Frequently Asked Questions about dotnet-openapi

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

FAQPage Schema
How do I generate OpenAPI documentation for an ASP.NET Core Web API?

You can generate OpenAPI documentation for ASP.NET Core by utilizing the Microsoft.AspNetCore.OpenApi package, which provides first-party support for modern .NET 9+ applications. This ensures your Web API endpoints are well-documented and discoverable.

What is the best way to migrate from Swashbuckle to Microsoft.AspNetCore.OpenApi?

Migrating from Swashbuckle.AspNetCore to the first-party Microsoft.AspNetCore.OpenApi package involves following specific migration guidance steps. This transition enables you to adopt modern OpenAPI 3.1 generation supported in .NET 10.

Can I use NSwag with ASP.NET Core for client generation?

Yes, you can integrate NSwag with ASP.NET Core specifically for advanced scenarios like client code generation. This works alongside the first-party Microsoft.AspNetCore.OpenApi package to handle complex API documentation requirements.

How do I customize OpenAPI schema and operations in ASP.NET Core?

You can customize OpenAPI schema and operations in ASP.NET Core by applying document and operation transformers. This customization mechanism allows you to enrich the generated OpenAPI metadata dynamically during the API specification generation process.

Does Microsoft.AspNetCore.OpenApi support multiple OpenAPI documents in one project?

Microsoft.AspNetCore.OpenApi supports multiple document generation within a single ASP.NET Core application. You can configure distinct OpenAPI documents and apply document or operation transformers to customize each specification individually.