rest-api-design

name	rest-api-design
description	RESTful API design principles, versioning, pagination, HATEOAS, and documentation.
allowed-tools	Read, Write, Edit, Bash, Glob, Grep
graph	{"domains":["domain:web-development"],"specializations":["specialization:web-development"],"skillAreas":["skill-area:backend-api-design","skill-area:api-design"],"roles":["role:backend-engineer","role:tech-lead"],"workflows":["workflow:api-design-review"],"topics":["topic:rest","topic:api-design"]}

REST API Design Skill

Expert assistance for designing RESTful APIs following best practices.

Capabilities

• Design resource-oriented APIs
• Implement proper HTTP methods and status codes
• Configure API versioning strategies
• Implement pagination patterns
• Design error responses
• Apply HATEOAS principles

Usage

Invoke this skill when you need to:

• Design new REST APIs
• Review existing API design
• Implement pagination
• Define error handling
• Version APIs

Design Principles

Resource Naming

# Good - nouns, plural
GET /api/users
GET /api/users/123
GET /api/users/123/posts

# Bad - verbs, actions in URL
GET /api/getUsers
GET /api/users/123/getPosts
POST /api/createUser

HTTP Methods