Description
api-designer is an agent skill from the jeffallan claude-skills collection for designing REST and GraphQL APIs and writing OpenAPI 3.1 specifications. Its workflow has six steps: analyse the domain to understand business requirements, data models and client needs; model resources and their relationships, sketching an entity diagram before writing any spec; design endpoints with URI patterns, HTTP methods and request and response schemas; write the OpenAPI 3.1 contract and validate it with the Redocly linter; spin up a mock server with Prism to test the contract against real calls; and plan evolution, covering versioning, deprecation and backward compatibility. The skill also points the agent to detailed reference material for the situation at hand. It is intended for API architects and developers who want a contract settled before implementation begins. The skill is listed on skills.sh, where the page shows install counts and GitHub stars for the collection. Its Gen Agent Trust Hub audit is marked as failing, which is noted in the FAQ, while Socket and Snyk pass. Install it with npx skills add https://github.com/jeffallan/claude-skills --skill api-designer.…
Highlights
- REST and GraphQL API design
- OpenAPI 3.1 specifications
- Contract validation with Redocly
- Mock server with Prism
- Versioning and deprecation planning
- Installs from skills.sh
Ratings & Reviews
No ratings yet
Be the first to rate api-designer.
People also visit
contract-first
Coordinate frontend/backend or service-to-service work through one authoritative
api-documentation-generator
Generate comprehensive, developer-friendly API documentation from code
breakdown-feature-implementation
Detailed feature implementation plan generator following Epoch monorepo
api-designer FAQ
What does this skill do?
It guides an agent through designing REST or GraphQL APIs and writing OpenAPI 3.1 specifications before any implementation.
How does it check the spec?
The workflow validates the OpenAPI file with npx @redocly/cli lint, then runs a mock server with @stoplight/prism-cli to test the contract.
What about versioning?
The last step plans versioning, deprecation and backward compatibility.
How do I install it?
Run npx skills add https://github.com/jeffallan/claude-skills --skill api-designer.
What are the security audit results?
skills.sh lists three audits: Gen Agent Trust Hub Fail, Socket Pass and Snyk Pass. A Warn or Fail is worth reading before you install.
How popular is it?
The page shows about 6.2K installs, and the claude-skills repository has 11.9K GitHub stars.
What are the best api-designer alternatives?
Popular alternatives to api-designer include api-and-interface-design, graphql-architect and contract-first. See all api-designer alternatives