Skip to content
This repository was archived by the owner on Nov 28, 2022. It is now read-only.

Changing name to Eclipse Codewind tool for OpenAPI #715

Merged
merged 1 commit into from
Oct 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/_data/docstoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,11 @@
- title: 'Monitoring applications with the Performance Dashboard'
url: performance.html

- title: 'Eclipse Codewind OpenAPI Tools'
- title: 'Eclipse Codewind tool for OpenAPI'
children:
- title: 'Eclipse Codewind OpenAPI Tools in VS Code'
- title: 'Eclipse Codewind tool for OpenAPI in VS Code'
url: open-api-tools-for-vscode.html
- title: 'Eclipse Codewind OpenAPI Tools in Eclipse'
- title: 'Eclipse Codewind tool for OpenAPI in Eclipse'
url: open-api-tools-for-eclipse.html

- title: 'Configuring Codewind for Tekton pipelines'
Expand Down
14 changes: 7 additions & 7 deletions docs/_documentations/codewind-openapi-eclipse.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
layout: docs
title: Eclipse Codewind OpenAPI Tools in Eclipse
description: How to work with the Eclipse Codewind OpenAPI Tools in Eclipse
keywords: install, run, open, import, show, restart, edit, build, logs, tools, eclipse, Eclipse Codewind OpenAPI Tools
title: Eclipse Codewind tool for OpenAPI in Eclipse
description: How to work with the Eclipse Codewind tool for OpenAPI in Eclipse
keywords: install, run, open, import, show, restart, edit, build, logs, tools, eclipse, Eclipse Codewind tool for OpenAPI
duration: 1 minute
permalink: open-api-tools-for-eclipse.html
type: document
order: 30
---

# Eclipse Codewind OpenAPI Tools in Eclipse
# Eclipse Codewind tool for OpenAPI in Eclipse

The Eclipse Codewind OpenAPI Tools include 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.
The Eclipse Codewind tool for OpenAPI 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 Eclipse Codewind OpenAPI Tools, the earliest supported version of the Eclipse IDE for Codewind is Version 2019-06 (4.12).
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 the Eclipse Codewind tool for OpenAPI, the earliest supported version of the Eclipse IDE for Codewind is Version 2019-06 (4.12).
2. [Optional] Install [Codewind from the Eclipse Marketplace](https://marketplace.eclipse.org/content/codewind).
3. Install the [Eclipse Codewind OpenAPI Tools from the Eclipse Marketplace](https://marketplace.eclipse.org/content/codewind).
3. Install the [Eclipse Codewind tool for OpenAPI from the Eclipse Marketplace](https://marketplace.eclipse.org/content/codewind).

## Generating HTML and client and server stubs by using the OpenAPI wizard
1. Launch the context menu on any existing workspace projects or any `openapi.yaml` workspace OpenAPI definition files from the **Package Explorer** or **Project Explorer** views.
Expand Down
16 changes: 8 additions & 8 deletions docs/_documentations/codewind-openapi-vscode.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
layout: docs
title: Eclipse Codewind OpenAPI Tools in VS Code
description: How to work with the Eclipse Codewind OpenAPI Tools in VS Code
keywords: install, run, open, import, show, restart, edit, build, logs, tools, eclipse, Eclipse Codewind OpenAPI Tools in VS Code
title: Eclipse Codewind tool for OpenAPI in VS Code
description: How to work with the Eclipse Codewind tool for OpenAPI in VS Code
keywords: install, run, open, import, show, restart, edit, build, logs, tools, eclipse, Eclipse Codewind tool for OpenAPI in VS Code
duration: 1 minute
permalink: open-api-tools-for-vscode.html
type: document
order: 30
---

# Eclipse Codewind OpenAPI Tools in VS Code
# Eclipse Codewind tool for OpenAPI in VS Code

The Eclipse Codewind OpenAPI Tools in VS Code provide commands 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 VS Code, but they can also work without the Codewind extension.
The Eclipse Codewind tool for OpenAPI in VS Code provides commands 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 VS Code, but they can also work without the Codewind extension.

## Prerequisites
- Install Docker before you run the generator. In VS Code, the plug-in pulls in the OpenAPI generator image from [Docker](https://github.com/OpenAPITools/openapi-generator#16---docker).
Expand All @@ -20,9 +20,9 @@ The Eclipse Codewind OpenAPI Tools in VS Code provide commands that invoke the O
1. Install [VS Code version 1.27 or later](https://code.visualstudio.com/download).
2. (OPTIONAL) Install Codewind for VS Code from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.codewind) or by searching for `Codewind` in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
3. This extension pulls the [OpenAPI Generator CLI Docker Image](https://github.com/OpenAPITools/openapi-generator#16---docker) and runs the OpenAPI Generator in a Docker container. Install Docker if necessary.
4. Install the Eclipse Codewind OpenAPI Tools from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-openapi-tools) or by searching for `Codewind OpenAPI` in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
4. Install the Eclipse Codewind tool for OpenAPI from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-openapi-tools) or by searching for `Codewind OpenAPI` in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).

## Generating and building client and server stubs by using the Eclipse Codewind OpenAPI Tools
## Generating and building client and server stubs by using the Eclipse Codewind tool for OpenAPI
1. Right-click your Codewind project from the Codewind view and select either the **Generate Server from OpenAPI Definition** menu or **Generate Client from OpenAPI Definition** action. You are then prompted to provide options to the OpenAPI generator.
2. Select your OpenAPI document file. The file must be a valid OpenAPI 3.0 `.yaml` or `.json` file that is in the project.
3. Select the client or server generator type.
Expand All @@ -33,7 +33,7 @@ The Eclipse Codewind OpenAPI Tools in VS Code provide commands that invoke the O
8. Now, you can customize the application logic. Choose one of the two methods in the **Generating and building code in an existing Java Spring project** section.

## Generating and building code in an existing Java Spring project
When you generate a Spring server stub into a Spring project, Eclipse Codewind OpenAPI Tools don't override the main class that is already implicitly or explicitly configured in the project. Complete one of the following steps to expose the OpenAPI endpoints:
When you generate a Spring server stub into a Spring project, the Eclipse Codewind tool for OpenAPI doesn't override the main class that is already implicitly or explicitly configured in the project. Complete one of the following steps to expose the OpenAPI endpoints:
- To use the generated class, uncomment the main method in the `OpenAPI2SpringBoot.java` Java class file and explicitly configure the project to use this main class.
- To continue to use the currently configured main class, copy the base packages that are listed in the `@ComponentScan` component scan annotation from the `OpenAPI2SpringBoot.java` file. Then, add the packages to the currently configured main class. For example, if you use the Codewind Spring Boot project, the implicit main class is the `SBApplication.java` file.

Expand Down
8 changes: 4 additions & 4 deletions docs/_documentations/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The following sections contain workarounds for issues that you might encounter w
* [OpenShift Do (odo) with Codewind](#openshift-do-(odo)-with-codewind)
* [OKD and OpenShift](#okd-and-openshift)
* [Codewind and Tekton pipelines](#codewind-and-tekton-pipelines)
* [Eclipse Codewind OpenAPI Tools](#openapi-tools)
* [Eclipse Codewind tool for OpenAPI](#openapi-tools)
* [Setting Codewind server log levels](#setting-codewind-server-log-levels)
* [Collecting log files and environment data](#collecting-log-files-and-environment-data)
* [Restoring lost debug connections](#restoring-lost-debug-connections)
Expand Down Expand Up @@ -757,10 +757,10 @@ These steps reproduce the issue:
4. Now, access the Tekton dashboard URL from the Codewind palette.

***
# Eclipse Codewind OpenAPI Tools
# Eclipse Codewind tool for OpenAPI

<!--
Action/Topic: Eclipse Codewind OpenAPI Tools
Action/Topic: Eclipse Codewind tool for OpenAPI
Issue type: bug/info
Issue link: https://github.com/eclipse/codewind/issues/275
Version: 2019-06 (4.12.0)
Expand All @@ -785,7 +785,7 @@ For post-client or post-server stub generation, use a separate output folder for
For Eclipse, for Java-based code generators, the OpenAPI wizards provide additional support to configure the project. It is recommended that the project's root folder is selected as the output folder of the generator so that `.java` files will be generated into the existing `src/main/java` and `src/test/java` folders. The wizard's default value of the output folder is the project's root folder. The wizard also performs some automatic configuration, including `pom.xml` file merging, and necessary updates to the project's classpath.

<!--
Action/Topic: Plugin execution validation error in the pom.xml file for Eclipse Codewind OpenAPI Tools
Action/Topic: Plugin execution validation error in the pom.xml file for the Eclipse Codewind tool for OpenAPI
Issue type: bug
Issue link: https://github.com/eclipse/codewind/issues/650
0.5.0: New issue
Expand Down