design-api-spec

Generate an OpenAPI 3.1.0 specification from design stories and domain models.

41|7|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/paraskakis/skills --skill design-api-spec
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-api-spec
Source: https://github.com/paraskakis/skills/tree/main/api/design-api-spec
Command: npx skills add https://github.com/paraskakis/skills --skill design-api-spec

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate a standards-compliant OpenAPI 3.1.0 specification from API design stories, a domain model, API standards, and OpenAPI best practices, helping teams move from concepts to a validated document.

Core Features & Use Cases

  • Convert design inputs (stories, domain model, standards, and best practices) into a coherent OpenAPI document.
  • Lint and iterate the spec with optional RateMyOpenAPI integration to improve quality and SDK readiness.
  • Use cases include designing new APIs from scratch, or converting existing design artifacts into a ready-to-implement spec.

Quick Start

Provide the four required input documents and run the skill to generate a validated OpenAPI 3.1.0 specification.

Frequently Asked Questions about design-api-spec

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an OpenAPI 3.1.0 specification from API design stories and a domain model?

To generate an OpenAPI 3.1.0 specification, provide your API design stories, domain model, API standards, and OpenAPI best practices. This process transforms your design artifacts into a fully specified, DRY OpenAPI document with components and schemas.

What is the best way to enforce a DRY structure in an OpenAPI specification?

Enforcing a DRY OpenAPI structure involves generating the document from standardized design inputs like a domain model. This approach automatically organizes repeated definitions into reusable components and schemas, ensuring consistency and reducing redundancy across the API spec.

Can I lint my OpenAPI spec to improve SDK readiness?

Yes, you can lint your OpenAPI spec to improve SDK readiness by using the optional RateMyOpenAPI integration. When an API key is available, the linter evaluates the document and returns a validated score to help iterate and improve quality.

What inputs do I need to create a standards-compliant OpenAPI document from scratch?

Creating a standards-compliant OpenAPI document from scratch requires four inputs: design stories, a domain model, API standards, and OpenAPI best practices. These artifacts provide the necessary context to produce a validated, ready-to-implement specification.

Does this approach to API spec generation work without external linting dependencies?

Yes, API spec generation works without external linting dependencies. While RateMyOpenAPI integration is available for optional validation and scoring when an API key is provided, the core generation of the OpenAPI 3.1.0 document functions independently.