API Design

Design RESTful APIs with best practices, conventions, and OpenAPI specs

chainlesschain Updated

File contents

API Design Skill

Design and review APIs following RESTful best practices and industry conventions.

Usage

/api-design [mode] [requirements or file path]

Modes

  • design (default) - Design a new API from requirements
  • review - Review existing API endpoints for issues
  • openapi - Generate OpenAPI/Swagger specification
  • versioning - Plan API versioning strategy
  • errors - Design error codes and error response format

Examples

/api-design design User management API with CRUD and roles
/api-design review src/routes/api.js
/api-design openapi E-commerce product catalog API
/api-design versioning Plan v2 migration for payment API
/api-design errors Design error handling for authentication service

Output

API design document with endpoints, request/response schemas, status codes, and conventions.

chainlesschain/chainlesschain/tree/main/desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/api-design commit 5485c370e4

Frequently asked questions

npx skillmds@latest add chainlesschain/api-design