Standardize REST API responses, URL versioning, pagination, and error mapping.
npx skills add https://github.com/hendrax5/ironman --skill api-design-hendrax5
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/hendrax5/ironman/tree/main/skills/api-design Command: npx skills add https://github.com/hendrax5/ironman --skill api-design-hendrax5
Menyediakan standar tunggal untuk bentuk response, versioning, konvensi URL, pagination, dan penanganan error sehingga klien dan tim backend memiliki ekspektasi yang konsisten dan mudah ditrace.
data dan semua kegagalan mengembalikan error, disertai meta.requestId dan meta.timestamp untuk traceability.Design endpoints for the users resource using URL-based versioning, plural kebab-case paths, a data-or-error wrapper with meta.requestId and timestamp, and paginated list responses.
High-intent search queries and answers about installing and using this skill.
Standardize REST API responses by using a data-or-error wrapper that returns `data` for successes and `error` for failures, always including `meta.requestId` and `meta.timestamp` for traceability. This ensures predictable client behavior across all endpoints.
Handle pagination in REST API list endpoints by mandating page, limit, sort, and order parameters, while supporting filter and search capabilities. This enforces consistent data retrieval and prevents unbounded query responses.
URL-based versioning for REST API endpoints works by embedding the version directly in the path, such as `/api/v1/`. This approach requires plural kebab-case resources and limits nested resources to two levels to maintain structural simplicity.
Map HTTP status codes consistently by using 200, 201, 202, and 204 for successful operations, and standard 4xx and 5xx codes for client and server errors. All failures return an `error` object within the standard response wrapper.
Yes, you can apply this API design standard to backend web services, internal APIs, and public API design. It enforces consistent endpoint conventions, response formats, and traceability suitable for frontend integration and documentation tasks.
You need a `meta.requestId` and `meta.timestamp` in every API response wrapper to ensure full traceability. This allows backend teams and clients to track, debug, and observe specific requests across distributed systems and logs.
eng-vmessiahStandardizes REST API architecture including naming conventions, HTTP semantics, and error formats.
petbrainsGenerate REST endpoints and OpenAPI documentation from tRPC routers.
rrezartprebrezaStandardize Spring Boot REST APIs with unified response envelopes and error handling.
CloudAI-XDesign REST and GraphQL APIs with endpoints, versioning, and documentation.