openapi

Generate OpenAPI 3.1 documentation for .NET 10 APIs using Microsoft.AspNetCore.OpenApi.

Updated Apr 27, 2026
One-click install
npx skills add https://github.com/shahdanish/vibepos --skill openapi-shahdanish
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openapi
Source: https://github.com/shahdanish/vibepos/tree/main/skills/openapi
Command: npx skills add https://github.com/shahdanish/vibepos --skill openapi-shahdanish

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the problem of producing accurate, maintainable OpenAPI specifications for .NET web APIs without relying on third-party tooling that may be outdated or redundant.

Core Features & Use Cases

  • Built-in .NET 10+ OpenAPI: Use the framework-maintained Microsoft.AspNetCore.OpenApi to generate OpenAPI documents.
  • Correct schemas from typed results: Prefer TypedResults so response schemas are inferred reliably.
  • Transformers for deep customization: Apply document, operation, and schema transformers to add security schemes, global metadata, and formatting changes.
  • Endpoint metadata for discovery: Set WithName, WithSummary, WithDescription, and WithTags so the spec and client generation have strong operation identifiers.
  • Use cases: Secure API documentation (e.g., Bearer JWT), multi-document setups, per-endpoint operation customization, and build-time generation of spec files.

Quick Start

Use the openapi skill to generate and serve an OpenAPI document by calling AddOpenApi in your .NET app and mapping MapOpenApi in development.

Frequently Asked Questions about openapi

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

FAQPage Schema
How do I generate OpenAPI documentation in .NET without Swashbuckle?

To generate OpenAPI documentation without Swashbuckle, use the built-in Microsoft.AspNetCore.OpenApi pipeline by calling AddOpenApi and MapOpenApi in your .NET 10 application. This framework-maintained approach replaces outdated third-party tooling.

How do I ensure correct response schemas in my .NET OpenAPI document?

To ensure correct response schemas in your .NET OpenAPI document, use TypedResults for your endpoint responses. TypedResults reliably infers response schemas automatically, allowing the built-in Microsoft.AspNetCore.OpenApi pipeline to generate accurate specifications.

How do I add security schemes to OpenAPI documents in .NET?

To add security schemes to OpenAPI documents in .NET, apply document or operation transformers like IOpenApiDocumentTransformer. This transformer-based customization allows you to document security schemes such as Bearer JWT authentication directly within the generated specification.

Can I serve multiple OpenAPI documents from a single .NET application?

Yes, you can serve multiple OpenAPI documents from a single .NET application using the built-in Microsoft.AspNetCore.OpenApi pipeline. The framework supports multiple OpenAPI documents selection, allowing you to map different specifications for various API segments.

How do endpoint metadata enrichment improve .NET OpenAPI generation?

Endpoint metadata enrichment improves .NET OpenAPI generation by setting WithName, WithSummary, WithDescription, and WithTags on endpoints. This provides strong operation identifiers for the generated spec, resulting in more accurate client generation and API discovery.

What are the limitations of using the built-in .NET OpenAPI pipeline?

A limitation of the built-in .NET OpenAPI pipeline is that it requires .NET 10 and relies heavily on TypedResults for accurate response schema inference. Without TypedResults, schema generation may lack the reliability needed for correct documentation.