Transform requirements and domain models into a linted OpenAPI document.
npx skills add https://github.com/paraskakis/skills --skill design-api-paraskakis
Please help me install this Agent Skill. Skill: design-api Source: https://github.com/paraskakis/skills/tree/main/api/design-api Command: npx skills add https://github.com/paraskakis/skills --skill design-api-paraskakis
Design an API from a complete set of inputs (Requirements, Domain, API Standards, and OpenAPI Best Practices) and produce a reviewable set of API stories followed by a linted OpenAPI specification.
Provide the four required inputs (Requirements, Domain, API Standards, and OpenAPI Best Practices) or start from the bundled conference scheduling API example to generate a complete API design and spec.
High-intent search queries and answers about installing and using this skill.
To generate an OpenAPI spec from requirements, you provide four foundation inputs: Requirements, Domain model, API Standards, and OpenAPI Best Practices. The Skill transforms these into a validated OpenAPI document with proper schemas and error handling.
Designing an API end-to-end with consistent naming and pagination requires enforcing domain and standards files as reusable components. This ensures conventions are applied uniformly across the generated OpenAPI specification.
You do not need to provide API user stories to create an OpenAPI document. If stories are omitted, the Skill generates them for your review before proceeding to build the complete OpenAPI specification.
You can lint and score your OpenAPI specification by optionally integrating with RateMyOpenAPI. This provides automated linting and scoring, alongside local preview capabilities via Node.js tooling when available.
The generated API specification uses the OpenAPI 3.1.0 format by default. It produces a complete document containing proper schemas, components, and standardized error handling.
If you lack specific requirements, you can start from the bundled conference scheduling API example. This demonstrates the end-to-end workflow and provides the four required inputs to generate a complete API design and spec.
emilneuraz-aiGenerate validated OpenAPI 3.1 specifications for RESTful APIs from code or design-first workflows.
paraskakisGenerate an OpenAPI 3.1.0 specification from design stories and domain models.
is-ivanovGenerate minimal OpenAPI 3.0.3 YAML specs from product stories.
imehrEnforce API contracts with Zod and OpenAPI schemas for REST and RPC endpoints.
