Design and review REST APIs with resource naming, URL structure, HTTP methods, and status codes.
npx skills add https://github.com/whchi/agentic-coding --skill api-design-whchi
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/whchi/agentic-coding/tree/main/skills/api-design Command: npx skills add https://github.com/whchi/agentic-coding --skill api-design-whchi
Designing, implementing, and reviewing REST APIs to ensure consistency, correctness, and maintainability across endpoints, contracts, and versioning.
Review a draft REST API and apply the patterns to align endpoints, responses, and error handling.
High-intent search queries and answers about installing and using this skill.
REST API resource naming and URL structure should use nouns for endpoints and standard HTTP methods for actions. This ensures consistency and correctness across API contracts by applying structured guidance and example patterns to resource design.
Design pagination, filtering, and sorting patterns for REST endpoints by applying best-practice structures to query parameters. This enables efficient data retrieval and consistent client interactions across large collections of resources.
Use HTTP status codes that accurately reflect the outcome of API requests, such as 200 for success or 4xx for client errors. Correct status code usage enforces clear contracts and robust error handling across endpoints.
Implement REST API versioning strategies and deprecation practices by applying structured patterns to URLs or headers. This maintains backward compatibility and governes lifecycle changes across real-world project endpoints.
Follow guidelines for API authentication, authorization, and rate limiting to secure REST endpoints. Applying these patterns protects resources from unauthorized access and manages traffic load effectively.
Yes, you can review a draft REST API to validate endpoint contracts and align responses. The skill applies best-practice patterns to assess code changes and validate API design proposals for consistency.
traylinxDesign REST APIs and OpenAPI specifications with endpoint naming and schema validation.
686f6c61Generate API documentation with HTTP methods, routes, parameters, and schemas.
KanakMalpaniDesign REST API patterns for endpoint contracts, status codes, pagination, and versioning.
chidekinaDefine and enforce scalable REST and GraphQL API design patterns.
