# codewind-openapi-eclipse

**Repository Path**: mirrors_eclipse/codewind-openapi-eclipse

## Basic Information

- **Project Name**: codewind-openapi-eclipse
- **Description**: Extension for using OpenAPI Tools in the Eclipse IDE
- **Primary Language**: Unknown
- **License**: EPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Codewind OpenAPI Tools for Eclipse

[![License](https://img.shields.io/badge/License-EPL%202.0-red.svg?label=license&logo=eclipse)](https://www.eclipse.org/legal/epl-2.0/)
[![Build Status](https://ci.eclipse.org/codewind/buildStatus/icon?job=Codewind%2Fcodewind-openapi-eclipse%2Fmaster)](https://ci.eclipse.org/codewind/job/Codewind/job/codewind-openapi-eclipse/job/master/)
[![Chat](https://img.shields.io/static/v1.svg?label=chat&message=mattermost&color=145dbf)](https://mattermost.eclipse.org/eclipse/channels/eclipse-codewind)
[![Gitter](https://badges.gitter.im/OpenAPITools/openapi-generator.svg)](https://gitter.im/OpenAPITools/openapi-generator)

The Codewind OpenAPI Tools for Eclipse includes wizards that invoke the OpenAPI Generator to create API clients, server stubs, and HTML documentation from OpenAPI definitions. The tools are integrated and customized to work with Codewind for Eclipse, but they also work with a base Eclipse IDE for Java EE Developers installation.

## Installing
1. Download and install the latest [Eclipse IDE for Java EE Developers](https://www.eclipse.org/downloads/packages/release/) or use an existing installation. If you use Codewind OpenAPI Tools with Codewind, the earliest supported version of the Eclipse IDE is 4.11.0 (2019-03).
2. [Optional] Install [Codewind from the Eclipse Marketplace](https://marketplace.eclipse.org/content/codewind).
3. Install the [Codewind OpenAPI Tools from the Eclipse Marketplace](https://marketplace.eclipse.org/content/codewind).

## Running commands
1. Launch the context menu on any existing workspace projects or any `openapi.yaml` workspace OpenAPI document files from the **Package Explorer** or **Project Explorer** views.
2. If Codewind is installed, the context menu generator actions are available in the **Codewind Explorer** view.
3. Ensure at least one OpenAPI definition is in the project.
4. Select an action to generate the client or server stubs or HTML documentation.
5. Enter the requested information that is displayed in the wizard.
6. After generation, edit the `.openapi-generator-ignore` file to ensure that subsequent code generation does not overwrite custom code.

## Features
- Generate API clients in any of the supported [languages/frameworks](https://github.com/OpenAPITools/openapi-generator#overview).
- Generate server stubs in any of the supported [languages/frameworks](https://github.com/OpenAPITools/openapi-generator#overview).
- Generate HTML documentation from an OpenAPI definition.

## Contributing
[Submitting issues](https://github.com/eclipse/codewind-openapi-eclipse/issues)