Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reprezen/kaizen-openapi-editor
Eclipse Editor for the Swagger-OpenAPI Description Language
https://github.com/reprezen/kaizen-openapi-editor
api-description api-design eclipse eclipse-editor eclipse-ide editor json kaizen-openapi-editor language open-source openapi openapi-editor openapi3 oss rest swagger swagger-editor swagger-openapi yaml yaml-editor
Last synced: about 10 hours ago
JSON representation
Eclipse Editor for the Swagger-OpenAPI Description Language
- Host: GitHub
- URL: https://github.com/reprezen/kaizen-openapi-editor
- Owner: RepreZen
- License: epl-1.0
- Created: 2015-09-30T21:30:07.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-09-17T12:33:51.000Z (about 5 years ago)
- Last Synced: 2023-10-25T16:22:17.135Z (about 1 year ago)
- Topics: api-description, api-design, eclipse, eclipse-editor, eclipse-ide, editor, json, kaizen-openapi-editor, language, open-source, openapi, openapi-editor, openapi3, oss, rest, swagger, swagger-editor, swagger-openapi, yaml, yaml-editor
- Language: Java
- Homepage:
- Size: 19.4 MB
- Stars: 111
- Watchers: 16
- Forks: 12
- Open Issues: 141
-
Metadata Files:
- Readme: README.md
- License: License.txt
Awesome Lists containing this project
README
# KaiZen OpenAPI Editor for Eclipse
_KaiZen OpenAPI Editor_ is an Eclipse editor for the [industry standard API description language](http://openapis.org), formerly known as [Swagger](http://swagger.io). It now supports both [Swagger-OpenAPI version 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) and [OpenAPI version 3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md).
KaiZen Editor is a core component of [RepreZen API Studio](http://reprezen.com/swagger-tools), a comprehensive solution for API modeling, documentation, visualization, testing and code generation, built on Eclipse.
We welcome your suggestions and contributions!
## Eclipse Installer
KaiZen OpenAPI Editor is available on [Eclipse Marketplace](https://marketplace.eclipse.org/content/kaizen-openapi-editor). Drag-and-drop this button into Eclipse Oxygen or later to install, or [see below](#installing-kaizen-openapi-editor) for other options:
[](http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=3429028 "Drag to your running Eclipse workspace.")
## NEW! OpenAPI 3.0 Editing
KaiZen OpenAPI Editor now features full support for the [OpenAPI version 3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md) specification. [See here for further details.](https://github.com/RepreZen/KaiZen-OpenAPI-Editor/blob/master/OPEN_API_V3_SUPPORT.md)
## Feature Highlights
### Validation
### Code Assist
Code templates:
Keywords and values:
### Code Assist for References
Code assist for references has several scopes which can be viewed in sequence by pressing `Ctrl`+`Space` repeatedly:
* The first scope shows only elements from the current document.
* The second expands it to elements from the containing project.
* The third shows elements from the entire workspace.
Pressing the hotkey a fourth time starts the cycle over again, with document scope.
### Navigation to a Reference
You can navigate to a reference using `Ctrl`+`Click`:
### Quick Outline
Quick Outline can be invoked with `Ctrl`+`o`. Similar to code assist for references, it has three scopes: model, project, and workspace. It also allows filtering:
### Outline
Outline View shows the contents of the active OpenAPI spec:
## Installing KaiZen OpenAPI Editor
KaiZen OpenAPI Editor requires Java 8 (64-bit) and Eclipse Oxygen or later.
### Installing from Eclipse Marketplace
The [Eclipse Marketplace solution](https://marketplace.eclipse.org/content/kaizen-openapi-editor) is the easiest way to install KaiZen Editor into an Eclipse IDE. You can drag-and-drop the Install button from the browser into your Eclipse IDE, or use the built-in Eclipse Marketplace Client.
[](http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=3429028 "Drag to your running Eclipse workspace.")
### Installing from the Update Site
You can install KaiZen OpenAPI Editor into your Eclipse IDE by clicking `Help > Install New Software... > Add...`
This will show a dialog box where you can select the location of the update site.
Use the update site http://products.reprezen.com/swagedit/latest/ as the URL.
### Installing RepreZen API Studio
KaiZen Editor is included as a core component of RepreZen API Studio, which adds live documentation and diagram views, sandbox testing with the built-in mock service and Swagger-UI, powerful code generation, and other features.
RepreZen API Studio is available through two different installation options:
* [API Studio Desktop](http://www.reprezen.com/OpenAPI) installs as a standalone desktop application on Windows, MacOS or Linux.
* [API Studio for Eclipse](https://marketplace.eclipse.org/content/reprezen-api-studio) installs into an Eclipse IDE distribution, allowing you to use RepreZen's API design, documentation and development features in your primary Eclipse development environment.
[](http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=3138718 "Drag to your running Eclipse workspace.")
## Troubleshooting
See the [Troubleshooting Guide](https://github.com/RepreZen/SwagEdit/blob/master/TROUBLESHOOTING.md) for solutions to common problems.
## Contributing to KaiZen OpenAPI Editor
We welcome contributions - documentation, bug reports or bug fixes.
If you are interested in contributing to KaiZen Editor, please see the [Developer's Guide](https://github.com/RepreZen/SwagEdit/blob/master/DEVELOPERS_GUIDE.md).
We also created a list of [good first bugs](https://github.com/RepreZen/SwagEdit/labels/Good%20First%20Bug)
that are relatively easy to fix.
## License
KaiZen OpenAPI Editor is provided under the [Eclipse Public License v1.0](https://www.eclipse.org/legal/epl-v10.html)
## Video: KaiZen Editor in RepreZen API Studio
[](https://www.youtube.com/watch?v=KX_tHp_KQkE)
_**Note:** KaiZen Editor includes code assist, real-time validation, syntax highlighting, and outline view.
[Eclipse Color Theme](https://marketplace.eclipse.org/content/eclipse-color-theme) and [EditBox](http://marketplace.eclipse.org/content/nodeclipse-editbox-background-colors-themes-highlight-code-blocks-c-java-javascript-python) are available as separate plugins.
[RepreZen API Studio](http://reprezen.com/swagger-tools) includes the mock service, live Swagger-UI, advanced code generation, and other features that are not part of KaiZen Editor. See the [feature comparison here](https://support.reprezen.com/support/solutions/articles/24000046272-what-s-the-difference-between-kaizen-openapi-editor-and-reprezen-api-studio-)._