OpenAPI Generator

What OpenAPI Generator is

OpenAPI Generator creates API clients, server stubs, and documentation from OpenAPI 2.0 and 3.x documents. It offers more than 50 client generators and server stub generation for over 40 languages and technologies, including Java, Kotlin, Go, and PHP. Additional outputs include Apache2 configuration, MySQL, GraphQL schemas, and documentation formats such as HTML and Cwiki. It can convert OpenAPI 2.0 documents into OpenAPI 3.x JSON or YAML. Developers can adapt generated output with Mustache templates, configuration-provided files and extensions, or custom generators. The free plan costs nothing. The CLI can be installed through npm, Homebrew, Scoop, PyPI, Docker, JAR, JBang, or a Bash launcher script; supported installation routes cover Linux, macOS, and Windows, with some routes limited to particular operating systems. The JAR requires Java 11 or later. Integrations include Gradle, Maven, sbt, Bazel, GitHub, and CI/CD, and the project describes an active Slack community for questions.

Who it suits

It suits developers who generate API clients, server stubs, or documentation from OpenAPI documents and want to tailor output. The range of CLI installation choices and documented integrations can also suit teams working across supported operating systems and build systems.

Getting started

1. Visit https://openapi-generator.tech/ and choose an installation route.
2. Install the CLI through npm, Homebrew, Scoop, PyPI, Docker, JAR, JBang, or the Bash launcher.
3. For the JAR route, make sure Java 11 or later is available.
4. Provide an OpenAPI 2.0 or 3.x document as the generation input.
5. Select the client, server, or documentation output you need.
6. Customize output with Mustache templates, configuration files, or a custom generator.
7. Connect generation with a documented integration such as Gradle, Maven, GitHub, or CI/CD.

Verdict

OpenAPI Generator covers client, server-stub, and documentation generation, with options to customize output and integrate with common build workflows. Check the installation route and runtime requirements that fit your environment before choosing it.