rest-api-design-governance

Automate ASP.NET Core REST API design with resource-first contracts, CQRS, and OpenAPI standards.

Updated Apr 9, 2026
One-click install
npx skills add https://github.com/nist0/CoDev --skill rest-api-design-governance
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rest-api-design-governance
Source: https://github.com/nist0/CoDev/tree/main/.github/skills/rest-api-design-governance
Command: npx skills add https://github.com/nist0/CoDev --skill rest-api-design-governance

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the design and governance of ASP.NET Core REST APIs, ensuring resource-first contracts, controller boundaries, CQRS + IMediator, versioning, and OpenAPI quality.

Core Features & Use Cases

  • Resource-First Contract Design: Utilizes noun-based routes and standard HTTP verbs for consistent API structure.
  • Versioning and Boundaries: Implements robust versioning and controller boundaries for maintainable APIs.
  • CQRS and Mediator Pattern: Implements Command Query Responsibility Segregation (CQRS) with IMediator for clear business logic separation.
  • Error Handling and OpenAPI: Provides structured error handling and ensures API quality with OpenAPI standards.

Quick Start

Use the rest-api-design-governance skill to design a new API with the command 'design-api --resource Product --version v1'.

Frequently Asked Questions about rest-api-design-governance

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

FAQPage Schema
How do I design a REST API in ASP.NET Core using resource-first contracts?

REST API versioning and controller boundaries maintain long-term API stability by isolating changes. Robust versioning implementation ensures consistent resource-first contracts are preserved across updates without breaking existing client integrations.

How does CQRS with IMediator separate business logic in REST APIs?

CQRS with IMediator separates business logic by routing read and write operations through distinct command and query handlers. This pattern ensures clear separation of concerns within your REST API architecture and controller boundaries.

Can I use this approach to review an existing ASP.NET Core REST API design?

OpenAPI standards ensure REST API quality by providing structured documentation and error handling. Adhering to these standards automates governance checks for consistent API structure, noun-based routes, and controller boundary validation.

What is the best way to add a new resource to an existing ASP.NET Core REST API?

The best way to add a new resource is using the design-api command with the resource and version parameters. This automates creation of noun-based routes, CQRS handlers, and OpenAPI documentation for consistency.