skills.rest
is-ivanov
is-ivanovCOMMUNITY
Explore all skills by this author →
GitHub

api-spec

Generate minimal OpenAPI 3.0.3 YAML specs from product stories.

2|1|Updated Nov 7, 2025
Search Tags:#api design#openapi#rest#yaml#spec generation#story mapping#frontend integration
One-click install
npx skills add https://github.com/is-ivanov/rpm-ddd --skill api-spec-is-ivanov
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-spec
Source: https://github.com/is-ivanov/rpm-ddd/tree/main/.opencode/skills/api-spec
Command: npx skills add https://github.com/is-ivanov/rpm-ddd --skill api-spec-is-ivanov

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams quickly turn product stories into minimal, implementation-ready OpenAPI specifications without over-designing the API. It reduces ambiguity between frontend needs, story requirements, and backend contract design.

Core Features & Use Cases

  • Story-to-spec generation: Reads product stories, mockups, and interview notes to identify the smallest viable set of endpoints.
  • OpenAPI file creation: Produces endpoint documentation and OpenAPI 3.0.3 YAML files using consistent naming and versioning conventions.
  • MVP-focused API design: Avoids unnecessary endpoints, status routes, and redundant operations so teams can ship faster with a cleaner contract.
  • Use case: When a team starts a new feature story and needs API contracts for frontend integration, this Skill maps the story into practical REST endpoints and creates the initial spec files.

Quick Start

Ask the skill to generate an API specification for a specific story by name or story number.

Frequently Asked Questions about api-spec

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

FAQPage Schema
How do I generate OpenAPI specs from product stories?▼

Generating OpenAPI specs from product stories involves reading story requirements, mockups, and interview notes to identify the smallest viable set of REST endpoints. This process outputs minimal OpenAPI 3.0.3 YAML files for MVP delivery.

What is the best way to design MVP REST endpoints for frontend integration?▼

Designing MVP REST endpoints for frontend integration focuses on mapping story requirements to practical endpoints while avoiding unnecessary operations and redundant status routes. This approach produces a cleaner API contract to help teams ship faster.

How do I create an OpenAPI YAML file with consistent naming and versioning conventions?▼

Creating an OpenAPI YAML file with consistent naming conventions involves enforcing /api/v1 versioning, snake_case file naming, and kebab-case URLs. The specification generation process checks for existing specs before creating new files to maintain consistency.

Can I use story-driven API design workflows to define REST endpoints?▼

Story-driven API design workflows use specifications, mockups, and interview notes to define REST endpoints. This workflow targets MVP delivery by translating product stories into implementation-ready OpenAPI 3.0.3 specifications without over-designing the API.

Does OpenAPI spec generation work for reducing ambiguity between frontend and backend contract design?▼

OpenAPI spec generation reduces ambiguity between frontend needs, story requirements, and backend contract design. It maps frontend endpoint requirements into practical REST endpoints and creates initial spec files for immediate integration.

Related Skills

Explore More Software Engineering Skills→
xloxn69xloxn69
7

api-documentation-generator

Generate OpenAPI 3.0 YAML/JSON specifications for REST API endpoints.

Community
Basic
vietlinhh02vietlinhh02

OpenAPI

Generate OpenAPI 3.0.3 specifications for RESTful APIs with request bodies and error responses.

Community
Basic
DexploarerDexploarer
7

api-documentation-generator

Generate OpenAPI specifications from code annotations and existing endpoints.

Community
Advanced
rakovi4rakovi4
45

api-spec

Generate OpenAPI 3.0.3 specifications from project story data.

Community
Advanced