How to Generate the Client with OpenAPI Generator

Generating Clients with OpenAPI Generator

This document serves to outline the basic process of generating a client for an API based on an OpenAPI specification.

Useful Tools

• Swagger Editor can be used to convert JSON OpenAPI specifications to the appropriate YAML format for the generator to consume.
• OpenAPI Generator Usage documentation to better understand the limitations of the tool and available options.

Prerequisites

To generate a new client, you'll need to ensure you have a version of the JDK and OpenAPI Generator installed.

Getting Started

To generate the client, create a directory and navigate into it. You then simply need to run the following command

$ openapi-generator generate -i swagger-document.yaml --git-user-id GIT_USER_ID --git-repo-id GIT_REPO_ID -g go