dotnet-api-design

Audit ASP.NET Core APIs for versioning, error handling, DTOs, and OpenAPI.

Updated Aug 23, 2026

Search Tags:#architecture #versioning #openapi #validation #audit #aspnetcore #api-design

Ready to run

npx skills add https://github.com/amodelandme/skill-tree-dotnet --skill dotnet-api-design

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: dotnet-api-design
Source: https://github.com/amodelandme/skill-tree-dotnet/tree/main/.claude/skills/dotnet-api-design
Command: npx skills add https://github.com/amodelandme/skill-tree-dotnet --skill dotnet-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit an existing ASP.NET Core API for production readiness or guides the design of a new one from scratch. It traces the request lifecycle, evaluates critical architecture decisions, and yields a structured gap report or a wired-up Program.cs scaffold depending on mode.

Core Features & Use Cases

Audit mode traces the request lifecycle across versioning, error handling, validation, DTO usage, and OpenAPI coverage to surface five must-haves.
Greenfield mode interviews the developer on two key architectural decisions and generates a ready-to-run Program.cs scaffold.
Outputs actionable gaps, RFCs, and scaffolding that can be wired into the codebase to improve production readiness.

Quick Start

Audit my existing API for production readiness or generate a wired Program.cs scaffold for a new .NET API.

Frequently Asked Questions about dotnet-api-design

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

FAQPage Schema

How do I audit an existing ASP.NET Core API for production readiness?▼

To audit an ASP.NET Core API for production readiness, trace the request lifecycle across versioning, error handling, validation, DTO usage, and OpenAPI coverage to surface a structured gap report of five must-haves.

What are the must-haves for a production-ready .NET API design?▼

The five must-haves for a production-ready .NET API design are versioning, ProblemDetails for error handling, correct validation placement, DTO conventions, and OpenAPI documentation.

How do I generate a Program.cs scaffold for a new .NET minimal API?▼

To generate a Program.cs scaffold for a new .NET minimal API, use greenfield mode to interview architectural decisions and output a ready-to-run wired configuration for minimal APIs or controllers.

Does this API audit evaluate validation placement and DTO conventions?▼

Yes, this API audit evaluates validation placement and DTO conventions by tracing the request lifecycle to ensure your ASP.NET Core API meets structured production-readiness checks.

Can I use this to design an ASP.NET Core API from scratch?▼

Yes, you can use greenfield mode to design an ASP.NET Core API from scratch by answering key architectural questions to generate an actionable, wired Program.cs scaffold.

What's the best way to identify gaps in my API's OpenAPI documentation?▼

The best way to identify gaps in OpenAPI documentation is running an audit that checks coverage as one of five must-haves, yielding actionable RFCs to improve production readiness.