Overview Q & A Rating & Review
The Codewind OpenAPI Tools for VS Code provides commands that invoke the OpenAPI Generator to create API clients, server stubs, and HTML documentation from OpenAPI Specifications. The tools are integrated and customized to work with Codewind for VS Code, but they can also work without the Codewind extension.
VS Code version 1.27 or later. Install Codewind for VS Code from the
VS Code Marketplace or by searching for
Codewind in the
VS Code Extensions view. This extension pulls the
OpenAPI Generator CLI Docker Image and runs the OpenAPI Generator in a Docker container. Install Docker if necessary. Running commands
To access the commands, go to the
Explorer view group and open the Codewind view. See the available actions from the
Command Palette or the Codewind view.
Command Palette and type
OpenAPI to see the actions available.
Or, to access the context menu commands from the Codewind view, go to the context menu on a project and select one of the
Before you run a command, ensure the OpenAPI definition is in the folder or project.
After you generate code, edit the
.openapi-generator-ignore file to ensure that subsequent code generation does not overwrite custom code.