Design REST or GraphQL API contracts with OpenAPI 3.1 specifications.
npx skills add https://github.com/kamelmh/opencode-config --skill api-designer-kamelmh
Please help me install this Agent Skill. Skill: api-designer Source: https://github.com/kamelmh/opencode-config/tree/main/skills/api-designer Command: npx skills add https://github.com/kamelmh/opencode-config --skill api-designer-kamelmh
This Skill helps you turn messy product requirements into clear, consistent API designs that are easier to implement, document, and evolve without breaking clients.
Ask the api-designer skill to draft a production-ready API design for your domain, including resources, endpoints, OpenAPI documentation, pagination, errors, authentication, and versioning.
High-intent search queries and answers about installing and using this skill.
To design a production-ready REST API from ambiguous requirements, map domain entities and relationships first. This approach standardizes resource modeling, endpoint planning, and OpenAPI specifications to ensure the resulting API architecture is maintainable.
Handling API errors with RFC 7807 involves standardizing problem details for HTTP APIs. This approach provides consistent, machine-readable error responses, making your production-grade REST interfaces predictable and easier for clients to debug and evolve.
Writing OpenAPI 3.1 specifications involves creating endpoint plans with detailed validation guidance and examples. This ensures the API contract strictly satisfies production-grade REST principles and provides reliable interface documentation for implementation.
Yes, you can design both REST and GraphQL interfaces using a unified resource modeling process. This approach defines entities and relationships upfront, then plans specific endpoints, pagination strategies, and authentication for your chosen protocol.
You need to plan API versioning and deprecation strategies when evolving production-ready APIs to avoid breaking existing clients. This involves designing backward-compatible endpoint changes and documenting sunset timelines for older interface versions.
Yes, production-grade API design requires standardizing pagination and rate limiting to ensure interfaces are predictable and maintainable. These elements manage payload sizes and protect server resources alongside authentication and error handling.
peterquielDocument domain models with entities, relationships, and business rules.
AI-Foundry-CoreGenerate OpenAPI 3.1 specifications from code and design artifacts.
AgentSecOpsLint OpenAPI/AsyncAPI definitions with Spectral to enforce security and governance rules.
erichowensDesign and validate REST, GraphQL, and gRPC API contracts and architectures.
