# API Design

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

- Skill: `chainlesschain/api-design` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add chainlesschain/api-design`
- Raw SKILL.md: https://api.skillmd.com/api/skills/chainlesschain/api-design/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Web & Frontend
- Author: chainlesschain (https://skillmd.com/u/chainlesschain)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/chainlesschain/api-design

---


# 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.