Guide REST API design covering naming, HTTP methods, status codes, and pagination.
npx skills add https://github.com/flatrick/mdt --skill api-design-flatrick
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/flatrick/mdt/tree/main/skills/api-design Command: npx skills add https://github.com/flatrick/mdt --skill api-design-flatrick
This Skill provides comprehensive guidance and best practices for designing consistent, developer-friendly, and production-ready REST APIs, addressing common pitfalls in resource naming, status codes, pagination, filtering, error handling, versioning, and rate limiting.
Use the api-design skill to generate a standard error response structure for a 400 bad request error.
High-intent search queries and answers about installing and using this skill.
REST API resource naming conventions should establish clear URL structures and consistent naming patterns to ensure endpoints are well-structured and developer-friendly. This provides a standardized approach for frontend teams to consume.
Offset vs cursor-based pagination in REST APIs are covered as advanced patterns. Offset pagination uses basic skip and limit parameters, while cursor-based pagination provides more efficient data fetching for large datasets.
HTTP status codes for REST APIs must detail correct semantic usage for both success and error responses. Using standard HTTP method semantics ensures proper response formatting for 400 bad requests and other common errors.
Rate limiting and authentication patterns for backend web services are implemented to control traffic flow and secure access. These patterns include authorization mechanisms and versioning approaches to maintain production-ready APIs.
Code examples for TypeScript, Python, and Go are included throughout the API design guide. These examples demonstrate resource design, response formatting, and filtering mechanisms alongside an API design checklist for pre-launch validation.
rsmdtApply standardized REST and GraphQL design patterns to API contracts and versioning.
tapanshahAnalyze OpenAPI specifications against REST conventions and detect breaking changes.
calcosmicEnforce API security controls for authentication, authorization, and rate limiting.
Ayub-KhanDesign REST, GraphQL, gRPC, and WebSocket APIs with resource modeling and versioning.
