Guide API design across REST, GraphQL, and gRPC with versioning and error handling.
npx skills add https://github.com/lushly-dev/afd --skill design-apis
Please help me install this Agent Skill. Skill: design-apis Source: https://github.com/lushly-dev/afd/tree/main/.claude/skills/design-apis Command: npx skills add https://github.com/lushly-dev/afd --skill design-apis
This Skill provides expert guidance to design and review APIs, ensuring they are robust, maintainable, and easily consumable by both human developers and AI agents.
Use the design-apis skill to get guidance on designing a REST API with versioning and error handling best practices.
High-intent search queries and answers about installing and using this skill.
To design a REST API with versioning and error handling, follow resource modeling best practices and use RFC 9457 for standardized error responses. This ensures your API is robust, maintainable, and easily consumable by human developers.
An agent-friendly API is discoverable and usable by AI agents through OpenAPI 3.1 specification authoring and MCP tool integration. OpenAPI 3.1 provides a machine-readable contract that AI agents can easily parse to understand and interact with your endpoints.
Choosing between gRPC, GraphQL, and REST depends on your use case, as this Skill provides comprehensive design guidance across all three paradigms. REST suits resource modeling, GraphQL handles flexible data fetching, and gRPC optimizes high-performance inter-service communication.
Implement pagination and OAuth 2.1 security by following established API design patterns for rate limiting and access control. This Skill addresses these critical security considerations alongside pagination strategies to ensure robust resource protection.
API naming conventions and resource modeling best practices involve creating logical, consistent endpoint structures that clearly represent your domain entities. This Skill provides comprehensive guidance to ensure your API design follows industry standards.
Yes, you can use this guidance to review an existing microservice API for robustness and maintainability. The Skill helps evaluate your current API against best practices for resource modeling, error responses, and agent-friendly design.
686f6c61Design normalized relational database schemas up to 3NF with indexes and constraints.
oakossDesign, validate, and document RESTful APIs using OpenAPI 3.1.
dolsoonProtects against unauthorized access and monitors for policy violations in real time.
avgarciaManage OpenAPI specification changes before implementation work begins.
