OpenAPI Tools for Eclipse and Codewind
Generate client and server stubs, and HTML documentation from OpenAPI definitions. The tools work for both Eclipse IDE for Java EE Developers with or without Codewind for Eclipse.
- Download and install the latest Eclipse IDE for Java EE Developers or use an existing installation. Note that if using these tools with Codewind, the earliest supported version of the Eclipse IDE is 4.11.0 (2019-03).
- (Optional) Install Codewind from the Eclipse Marketplace.
- Install the OpenAPI Tools for Eclipse and Codewind from the Eclipse Marketplace.
- Invoke the context menu on any existing workspace projects or any workspace OpenAPI definition files (openapi.yaml) from the Package Explorer or Project Explorer views.
- If Codewind is installed, the context menu generator actions are available in the Codewind Explorer view
- Ensure at least one OpenAPI definition is in the project
- Select an action to generate the client or server stubs or HTML documentation
- Fill in information that is displayed from the wizard
- After generation, edit .openapi-generator-ignore to ensure subsequent code generation does not overwrite custom code
- Generate API clients in any of the supported languages/frameworks
- Generate server stubs in any of the supported languages/frameworks
- Generate HTML documentation from an OpenAPI definition file.