Provide guidelines for designing RESTful APIs with resource naming and HTTP methods.
npx skills add https://github.com/LiamVDB1/opencode-config --skill api-design-liamvdb1
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/LiamVDB1/opencode-config/tree/main/skills/api-design Command: npx skills add https://github.com/LiamVDB1/opencode-config --skill api-design-liamvdb1
This Skill provides a comprehensive guide to designing production-ready REST APIs, ensuring consistency, developer-friendliness, and maintainability.
Use the api-design skill to review the resource naming conventions for a new user endpoint.
High-intent search queries and answers about installing and using this skill.
REST API resource naming requires clear conventions for URLs and resource representation to ensure consistency. Establishing standardized paths for collections and items provides a maintainable structure for web services.
Effective API communication uses semantic HTTP methods and status codes to indicate request outcomes. Applying the correct HTTP verbs and response codes ensures clear API contracts and improves the developer experience.
Formatting API responses involves defining consistent patterns for success, collection, and error outputs. Including pagination, filtering, and sorting parameters within collection responses ensures scalable data retrieval.
API versioning and rate limiting manage API evolution and prevent abuse in production environments. Outlining strategies for version transitions and request throttling maintains robust and scalable backend services.
REST API design covers authentication and authorization mechanisms to secure web services. Enforcing standards for access control ensures that API endpoints validate user permissions and protect sensitive resources.
walker-hzxDefine a production-grade blueprint for building FastAPI backends.
BuildSmarterAIDesign REST API patterns for naming, status codes, pagination, and versioning.
cenjieSecure REST APIs with authentication, rate limiting, CORS, and input validation.
enchantednaturesDesign standardized REST, GraphQL, and gRPC APIs with versioning and error handling.
