Which API formats does this skill support?

The skill supports Markdown for human documentation, OpenAPI 3.1 (YAML) for REST specifications, and GraphQL SDL for schema definitions.

How does the interactive hearing work?

Claude will ask a batch of 1-4 targeted questions regarding your API's endpoints, authentication, and data structures to ensure the generated spec is accurate.

Where are the generated API specifications saved?

By default, files are saved to the project's /docs directory, but you can provide a custom path during the process.

Does it support Mermaid diagrams?

Yes, when generating Markdown documentation, the skill includes Mermaid sequence diagrams to visualize API data flows.

Can it generate multiple formats from one conversation?

Yes, the skill can use the information gathered during the interactive hearing to output multiple formats simultaneously.

API Spec Generator

Name: API Spec Generator
Author: DIO0550

byDIO0550

•

API Development

Generates comprehensive API documentation, OpenAPI definitions, and GraphQL schemas through an interactive requirements-gathering dialogue.

The API Spec Generator skill streamlines the backend design process by guiding developers through a structured hearing to define endpoints, authentication, and data structures. It supports three distinct outputs: human-readable Markdown documentation with Mermaid diagrams, machine-readable OpenAPI 3.1 YAML specifications, and well-documented GraphQL schemas. By using interactive questioning and standardized templates, it ensures your API design is consistent, professional, and ready for implementation or client consumption.

Key Features

01Generates OpenAPI 3.1 compliant YAML definitions for REST APIs

02Smart format detection from natural language requests like 'Write a swagger doc'

03Produces well-documented GraphQL SDL schemas including queries and mutations

04Interactive multi-question hearing pattern for thorough requirement gathering

05Creates Markdown documentation including Mermaid sequence diagrams for data flows

061 GitHub stars

Use Cases

01Designing a new RESTful service with standardized OpenAPI/Swagger specifications

02Creating human-friendly API documentation for internal team handovers

03Defining complex GraphQL schemas and types before starting implementation

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add dio0550/d-market api-spec

For use in Claude.ai and ChatGPT

Download Skill