Design and validate REST and GraphQL APIs using contract-first principles.
npx skills add https://github.com/xiaoshuangLi/aibo --skill api-design-xiaoshuangli
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/xiaoshuangLi/aibo/tree/main/skills/api-design Command: npx skills add https://github.com/xiaoshuangLi/aibo --skill api-design-xiaoshuangli
Design and review APIs that are consistent, scalable, and easy to evolve across REST and GraphQL, reducing contractual drift and integration friction.
Draft an OpenAPI specification for your API and follow contract-first design to align REST and GraphQL choices.
High-intent search queries and answers about installing and using this skill.
Contract-first API design involves drafting an OpenAPI specification before writing code, ensuring consistent REST and GraphQL contracts. This approach reduces contractual drift and minimizes integration friction by aligning interface choices early across enterprise scenarios.
To design REST APIs, apply standard HTTP methods, predictable resource naming, correct status codes, and efficient pagination. Following these design principles ensures your API remains consistent, scalable, and easy to evolve while maintaining predictable filtering behaviors.
The best way to version APIs during migration involves using structured versioning strategies and deprecation practices. Planning your API migration with clear governance ensures evolving REST and GraphQL interfaces remain backward-compatible without breaking existing integrations.
To document an OpenAPI specification, define secure authentication and authorization patterns directly within your contract. Generating OpenAPI/Swagger documentation ensures your API design reviews capture necessary security governance for evolving interfaces.
Yes, contract-first design applies to both REST and GraphQL across common enterprise scenarios. It guides naming, versioning, and status code choices, ensuring predictable APIs and secure authentication patterns regardless of the protocol used.
00PrabalK00Define and document API contracts with OpenAPI schemas before implementation.
Dokkabei97Design API contracts with OpenAPI and GraphQL schemas.
AbsolutelySkilledAutomate API testing across REST and GraphQL services with Supertest, Pact, MSW, and Zod schemas.
GaryOcean428Validate REST API endpoint naming, HTTP methods, and status codes.
