Design OpenAPI specifications and documentation for REST and GraphQL services.
npx skills add https://github.com/elsolal/Skillz-Claude --skill api-designer-elsolal
Please help me install this Agent Skill. Skill: api-designer Source: https://github.com/elsolal/Skillz-Claude/tree/main/.claude/skills/api-designer Command: npx skills add https://github.com/elsolal/Skillz-Claude --skill api-designer-elsolal
This Skill guides teams to design robust APIs and OpenAPI specifications for API-first projects, ensuring consistent interfaces, versioning, and thorough documentation across REST and GraphQL services.
Start by providing a PRD or architecture context and begin drafting resources, endpoints, and OpenAPI specs.
High-intent search queries and answers about installing and using this skill.
To design an OpenAPI specification, provide your PRD or architecture context to define resources, endpoints, and data models, resulting in consistent API specs and validation guidance for your REST service.
The best way to draft API documentation for an API-first project is to generate OpenAPI specs from your architecture descriptions, ensuring frontend and backend teams align on endpoint definitions and security patterns.
Yes, you can create both REST and GraphQL endpoint definitions by applying design patterns to your architecture descriptions, ensuring consistent naming and security across both service types.
You need a PRD or architecture description to start designing API specifications, as this context is required to define resources, establish versioning strategies, and generate accurate OpenAPI specs.
You establish API versioning and security patterns by applying consistent design rules during the OpenAPI specification process, ensuring backward compatibility across your service endpoints.
Designing APIs without an architecture description limits the ability to generate accurate OpenAPI specs, as the design process requires architecture context to define resources, endpoints, and validation guidance.
0xHoneyJarExtract functional and non-functional requirements from a PRD into a Software Design Document.
KILWA73Validates backend responses against OpenAPI specification and generates deterministic tests.
ymkzGenerate OpenAPI specs from Spring Boot for TypeScript frontend clients.
jankneumannDesign stable REST/GraphQL API contracts with version-safe TypeScript and Python types.
