api-design

Design and review REST, GraphQL, and internal API contracts with versioning and OpenAPI documentation.

1|Updated Mar 27, 2026
One-click install
npx skills add https://github.com/NEXUZ-SYS/devflow --skill api-design-nexuz-sys
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/NEXUZ-SYS/devflow/tree/main/skills/api-design
Command: npx skills add https://github.com/NEXUZ-SYS/devflow --skill api-design-nexuz-sys

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API design and governance ensures consistent contracts, predictable behavior, and clear documentation across services to reduce integration risks and maintenance costs.

Core Features & Use Cases

  • Define clear contracts with endpoints, methods, request/response shapes
  • Enforce versioning strategies to support backwards compatibility
  • Standardize error handling formats and response schemas
  • Produce and maintain machine-readable documentation (OpenAPI/Swagger)

Quick Start

Define a new API contract by outlining endpoints, methods, and response shapes, then validate it against your project's standards.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design REST API contracts with consistent endpoints and response shapes?▼

Design REST API contracts by explicitly defining endpoints, methods, and request/response shapes to ensure consistency and clarity. This process reduces integration risks by producing predictable behavior and clear documentation across services.

What is the best way to enforce backwards compatibility during API versioning?▼

Enforce backwards compatibility during API versioning by applying structured versioning strategies to your API design. This ensures consistent contracts and predictable behavior across services when modifying existing API contracts.

How do I generate machine-readable documentation for an API?▼

Generate machine-readable documentation by producing and maintaining OpenAPI or Swagger standards within your API design. This standardizes your API contracts and ensures clear documentation across REST, GraphQL, and internal interfaces.

Can I use this for both REST and GraphQL API governance across teams?▼

Yes, you can govern both REST and GraphQL APIs across teams by designing and reviewing API contracts. This standardizes error handling formats, versioning plans, and documentation for cross-team API governance in software projects.

How do I standardize error handling formats and response schemas?▼

Standardize error handling formats and response schemas by defining clear API contracts during the design phase. This ensures consistent behavior and reduces maintenance costs across internal and external interfaces.