Guide REST API design covering resource naming, HTTP methods, status codes, and error handling.
npx skills add https://github.com/Aytsuu/codemini --skill api-design-aytsuu
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/Aytsuu/codemini/tree/main/.agents/skills/api-design Command: npx skills add https://github.com/Aytsuu/codemini --skill api-design-aytsuu
This Skill provides a comprehensive guide to designing and implementing production-ready REST APIs, helping you avoid common pitfalls and follow best practices.
Design a REST API for user management using the api-design skill.
High-intent search queries and answers about installing and using this skill.
REST API design best practices dictate using nouns for resource naming and standard HTTP methods like GET, POST, PUT, and DELETE to perform operations. This approach ensures a predictable, developer-friendly API contract.
Handling errors in REST API development requires returning standard HTTP status codes and consistent error response payloads. This helps clients understand failures and recover without parsing undocumented formats.
Designing REST API pagination involves implementing limit and offset parameters or cursor-based tokens. This controls payload sizes and improves response times when clients request large dataset collections.
Planning an API versioning strategy involves embedding version numbers in the URI or HTTP headers. This allows you to introduce breaking changes without disrupting existing API consumers.
Yes, you can use this API design guidance to review existing API contracts. It provides patterns for resource naming, status codes, and error handling to ensure your current endpoints align with production-ready standards.
You should implement API-first design patterns when building API-first systems where multiple services or clients depend on your interface. It establishes a stable contract before backend development begins.
takemo101Generate foundational system design documents in Japanese with Mermaid diagrams.
franroaDesign REST and GraphQL APIs with OpenAPI 3.1 specifications.
heysuhasExpose local network services via secure SSH reverse tunnels.
Camilo8902Migrate REST APIs to GraphQL incrementally using schema stitching and REST data source wrappers.
