Skip to content
Skillpedia
APIs & servers (backend)40k · #5010

aspnet-minimal-api-openapi

Lets your agent create ASP.NET Minimal API endpoints with OpenAPI documentation. It ensures APIs are easy to use and understand.

What it does

This tool helps create code snippets for a website or web application using ASP.NET. It ensures that information sent and received is organized and that the documentation (like a manual) is clear and complete.

When to use it

  • ✓When you need to create new features for a website.
  • ✓When organizing multiple parts of a web application.
  • ✓To ensure your code's documentation is always up-to-date.

Example of what to ask your AI

“Create an endpoint to register a new user with name and email, and return the ID of the created user.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/github/awesome-copilot/blob/main/skills/aspnet-minimal-api-openapi/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/github/awesome-copilot/blob/main/skills/aspnet-minimal-api-openapi/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

You describe the information your code needs to receive and what it should return. The tool organizes this and automatically generates documentation, like a map for other developers.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add github/awesome-copilot --skill aspnet-minimal-api-openapi

Or download just the file:

curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/aspnet-minimal-api-openapi/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

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
FAQ

What are 'endpoints'?

They are like entry points for your application to send and receive specific information.

What is 'OpenAPI/Swagger'?

It's a standard way to describe and document APIs (the 'entry points') so others can understand how to use them.

What are 'DTOs/models'?

These are structures that define how data should be organized when it's sent or received by your application.

Details

Original description by the author

Create ASP.NET Minimal API endpoints with proper OpenAPI documentation

repo: github/awesome-copilot

Popularity

GitHub stars
40k
Ranking position
#5010
License
MIT
Updated
10/15/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills