rest-api-design

Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats. Use when building new APIs, establishing API conventions, or designing developer-friendly interfaces.

By secondsky · 531 installs

npx skills add secondsky/claude-skills --skill rest-api-design

Source repository · Upstream listing

REST API Design Design RESTful APIs with proper conventions and developer experience. Resource Naming HTTP Methods Method Purpose Idempotent GET Read resource Yes POST Create resource No PUT Replace resource Yes PATCH Partial update Yes DELETE Remove resource Yes Status Codes Code Meaning Use For 200 OK Successful GET, PATCH 201 Created Successful POST 204 No Content Successful DELETE 400 Bad Request Validation errors 401 Unauthorized Missing auth 403 Forbidden Insufficient permissions 404 Not Found Resource doesn't exist 429 Too Many Requests Rate limited Response Format Collection Response Query Parameters Best Practices Use nouns for resources, not verbs Version API via URL path ( /api/v1/ ) Return appropriate status codes Include pagination for collections Document with OpenAPI/Swagger