- Home
- API Documentation Tools
- OpenAPI 3 Generator
On the recordRead 10 Oct 202618 facts
OpenAPI 3 Generator
On the record
- CLI
- The tool can be installed globally with npm and run from the command line as `og`.github.com · read 4 Oct 2026
- CLI input
- The CLI accepts an OpenAPI file or URL and a template as inputs.github.com · read 10 Oct 2026
- Customization
- A template can define Handlebars helpers in a `.helpers` directory and partials in a `.partials` directory.github.com · read 10 Oct 2026
- Data available
- The generator passes the OpenAPI specification to templates and provides `openapi.endpoints` for first-level endpoints.github.com · read 10 Oct 2026
- Dependencies
- The package lists Handlebars, YAML parsing, OpenAPI validation, and Markdown generation dependencies.github.com · read 4 Oct 2026
- Dependency
- The package lists Handlebars as a dependency.github.com · read 10 Oct 2026
- Distribution
- The README documents global npm installation and command-line use.github.com · read 10 Oct 2026
- Input
- The CLI accepts an OpenAPI file or URL and a template as arguments.github.com · read 4 Oct 2026
- Input formats
- The README shows an OpenAPI definition in YAML format as an example input.github.com · read 4 Oct 2026
- Installation
- The README gives `npm install -g openapi3-generator` as the CLI installation command.github.com · read 10 Oct 2026
- License
- The repository includes an Apache License, Version 2.0.github.com · read 10 Oct 2026
- Maintainers
- The README lists Fran Méndez and Richard Klose as authors.github.com · read 10 Oct 2026
- Purpose
- OpenAPI 3 Generator uses an OpenAPI 3 definition to generate code, documentation, and other outputs.github.com · read 10 Oct 2026
- Requirements
- The project lists Node.js v7.6 or later as a requirement.github.com · read 4 Oct 2026
- Runtime requirement
- The README lists Node.js v7.6+ as a requirement.github.com · read 10 Oct 2026
- Support channel
- The repository page provides an Issues section for the project.github.com · read 10 Oct 2026
- Template data
- Templates receive the OpenAPI specification and an `openapi.endpoints` value containing first-level endpoints.github.com · read 4 Oct 2026
- Templates
- Templates can contain static files, Handlebars templates, and path templates that generate a file for each OpenAPI path.github.com · read 10 Oct 2026
