openapi

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

1|Updated Mar 27, 2026
One-click install
npx skills add https://github.com/Maj3D10/Training-Platform --skill openapi-maj3d10
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openapi
Source: https://github.com/Maj3D10/Training-Platform/tree/main/.agent/skills/openapi
Command: npx skills add https://github.com/Maj3D10/Training-Platform --skill openapi-maj3d10

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you produce accurate OpenAPI documentation for .NET 10 APIs using the built-in OpenAPI support, avoiding extra tooling and ensuring the spec reflects real endpoint behavior.

Core Features & Use Cases

  • Built-in .NET 10 OpenAPI: Use Microsoft.AspNetCore.OpenApi to generate OpenAPI documents without Swashbuckle.
  • TypedResults-driven schemas: Rely on TypedResults union return types so response schemas match your actual controller/endpoint contracts.
  • Transformers for customization: Add document, operation, and schema transformers for security schemes, metadata, and schema tweaks.
  • Production-ready endpoint metadata: Apply .WithName(), .WithSummary(), and .WithTags() so client generation and operationIds stay clean.
  • Multiple documents & grouping: Create versioned or segmented specs (e.g., public vs internal) with WithGroupName while sharing common endpoints.
  • XML comments integration: Enable GenerateDocumentationFile and let .NET extract summaries/params/responses into the spec.

Quick Start

Tell the AI: "Set up built-in OpenAPI for my .NET 10 minimal API, enable /openapi/v1.json in development, and add a Bearer security scheme to the OpenAPI documents using a document transformer."

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 for .NET 10 without Swashbuckle?

Generate OpenAPI 3.1 docs without Swashbuckle by registering Microsoft.AspNetCore.OpenApi, calling AddOpenApi and MapOpenApi, and using TypedResults so response schemas match your actual endpoint contracts.

How do I add a Bearer security scheme to .NET minimal API OpenAPI docs?

Add a Bearer security scheme to OpenAPI docs by implementing a document transformer, which customizes the generated OpenAPI document to include security definitions and other metadata requirements.

Why are my response schemas missing from the .NET 10 OpenAPI spec?

Response schemas are missing when not using TypedResults union return types; TypedResults allows the built-in OpenAPI generator to infer and accurately map your actual endpoint response contracts into the spec.

Can I create multiple versioned OpenAPI documents for a single .NET 10 API?

Create multiple versioned or segmented OpenAPI documents by assigning endpoints with WithGroupName, allowing you to share common endpoints while producing separate public or internal specs.

How do I include XML comments in .NET 10 OpenAPI documentation?

Include XML comments in OpenAPI documentation by enabling GenerateDocumentationFile in your project, allowing the built-in generator to extract summaries, parameters, and responses into the spec automatically.

What are OpenAPI transformers used for in .NET 10 minimal APIs?

OpenAPI transformers customize generated documentation by modifying document, operation, and schema levels, enabling security scheme definitions, metadata tweaks, and schema adjustments for production-ready endpoint output.