Design RESTful APIs with resource naming, HTTP methods, and status codes.
npx skills add https://github.com/Kimjiman/basic-arch --skill api-design-kimjiman
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/Kimjiman/basic-arch/tree/main/.claude/skills/api-design Command: npx skills add https://github.com/Kimjiman/basic-arch --skill api-design-kimjiman
This Skill provides a comprehensive guide to designing and implementing production-ready REST APIs, ensuring consistency, developer-friendliness, and adherence to best practices.
/users endpoint, use this Skill to determine the correct URL structure (/api/v1/users), HTTP methods (GET, POST, PUT, DELETE), status codes (200, 201, 404), and response formats for both single users and collections.Use the api-design skill to generate a standard error response for a 400 bad request.
High-intent search queries and answers about installing and using this skill.
REST API resource naming uses clear, intuitive endpoint conventions like `/api/v1/users`. This ensures your web services are consistent and developer-friendly by establishing a standardized URL structure for accessing resources.
Design REST API pagination, filtering, and sorting by implementing standard response formats for collections. This ensures efficient data retrieval and manipulation, allowing clients to request specific subsets of data without overloading the backend.
Use HTTP status codes like 200 for success, 201 for creation, and 404 for not found. Semantic use of these HTTP verbs and status codes ensures effective communication between the REST API and its clients.
Handle REST API security by implementing essential access control mechanisms. This covers authentication, authorization, and rate limiting to protect web services from unauthorized access and excessive requests.
Yes, you can use this skill with TypeScript, Python, and Go backends. It offers implementation patterns specifically for these languages to help you build robust and scalable REST APIs.
Version a REST API by outlining best practices for managing API evolution, often using a version number in the URL path like `/api/v1/`. This manages breaking changes while maintaining backward compatibility for web services.
KuaaMUGuide REST API design covering naming, methods, status codes, and versioning.
hffmnnjGenerate API reference documentation from OpenAPI specs and GraphQL schemas.
boomNDSApply authentication, authorization, input validation, and rate limiting patterns to secure APIs.
majiayu000Design API contracts for REST, GraphQL, and gRPC contexts.