api-spec

You can generate an OpenAPI 3.1 specification in YAML by interactively providing endpoint details, request/response schemas, authentication, and error handling. The Skill guides you through a structured hearing process to collect these necessary API details.

Yes, you can create Markdown, OpenAPI 3.1 YAML, and GraphQL SDL formats from one session. The Skill supports automated format detection and custom output paths, generating human-readable and machine-readable API documentation simultaneously.

To generate API documentation, you need details about your endpoints, request/response schemas, authentication methods, and error handling. The Skill interactively prompts you for these specific API details during the generation process.

Yes, the API specification generator supports automated format detection for Markdown, OpenAPI 3.1, and GraphQL schema outputs. It also allows you to specify custom output paths for saving the generated specification files.

The best way to document a new REST API is generating a comprehensive Markdown document for developers and an OpenAPI spec for integration tools. This Skill interactively gathers your API details to produce both formats, plus GraphQL SDL if needed.

You should use GraphQL schema generation when you need GraphQL SDL alongside Markdown and OpenAPI 3.1 formats. The Skill interactively collects your endpoint and schema details, allowing you to produce GraphQL schemas if needed from the same session.