Skip to content

Latest commit

 

History

2 Commits

Folders and files

Repository files navigation

API Documentation Generator

Generate beautiful, interactive API documentation from OpenAPI specs in minutes. Self-hosted or managed.

Deploy License: MIT

What It Does

Upload an OpenAPI 3.0/3.1 or Swagger 2.0 spec and get:

  • Complete API reference with parameters, responses, and examples
  • Multi-language code snippets — JavaScript, Python, Ruby, PHP, Java, Go, C#, and curl
  • Auto-generated tutorials based on your API structure
  • SDK integration snippets for popular frameworks
  • Error handling guides with common errors and solutions
  • Custom themes matching your brand colors, fonts, and style
  • Multiple export formats — Markdown, HTML, PDF

Quick Start

  1. Export your OpenAPI spec (JSON or YAML)
  2. Upload to API Documentation Generator
  3. Customize the theme
  4. Publish — get a shareable URL or embed in your docs

Try With a Sample

This repo includes a sample Petstore spec. Download sample-specs/petstore-openapi.yaml and upload it to see what the generator produces. The output is in generated-docs/petstore-api-docs.md.

Features

  • Instant generation from any OpenAPI 3.0/3.1 or Swagger 2.0 spec
  • Code examples in 7+ programming languages
  • AI-generated step-by-step tutorials
  • SDK snippets for popular frameworks
  • Version management for multiple API versions
  • Custom themes with brand colors and fonts
  • Custom domains for hosted docs
  • Export to Markdown, HTML, or PDF
  • Searchable, navigable documentation

Pricing

Plan Price What's Included
Pro $49/mo Unlimited specs, all languages, custom domain
Team $99/mo 5 team members, analytics, priority support
Lifetime $199 one-time Everything in Team, forever access

Sample Output

See generated-docs/petstore-api-docs.md for a full example of generated documentation from the Petstore OpenAPI spec in sample-specs/.

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT — see LICENSE for details.

Support

Releases

Packages

Contributors