Eclipse Editor for the Swagger-OpenAPI Description Language
Clone or download
tfesenko Merge pull request #473 from RepreZen/task/ZEN-4367
ZEN-4367, ZEN-3845  - Resource templates don't populate schema reference correctly
Latest commit e5b4815 Sep 18, 2018
Permalink
Failed to load latest commit information.
.settings Add eclipse project files. Oct 2, 2015
com.reprezen.swagedit.core Merge pull request #473 from RepreZen/task/ZEN-4367 Sep 18, 2018
com.reprezen.swagedit.feature #112 - Finalize version 0.8 for SwagEdit release May 8, 2017
com.reprezen.swagedit.openapi3.tests Fix maven compilation error by removing an import of Mockito (can't e… Sep 6, 2018
com.reprezen.swagedit.openapi3 Merge pull request #473 from RepreZen/task/ZEN-4367 Sep 18, 2018
com.reprezen.swagedit.repository [#387] Remove "SwagEdit" references from validation error and warning… Sep 28, 2017
com.reprezen.swagedit.target.kepler [releng] Update java runtime requirement from Java7 to Java8 Aug 9, 2018
com.reprezen.swagedit.target ZEN-4422 Use latest KZOP+JOvl Sep 11, 2018
com.reprezen.swagedit.tests ZEN-4367 - Renamed ProposalBuilder->ProposalBuilder + other changes Sep 7, 2018
com.reprezen.swagedit [ZEN-4360] OAS3 Syntax Coloring: some characters colored black Sep 11, 2018
etc Added screenshot for file new Jun 7, 2017
.gitignore Remove Xtend Gen folders from Git registry Jul 28, 2016
.project Add eclipse project files. Oct 2, 2015
DEVELOPERS_GUIDE.md Made numbering consistent May 9, 2017
GETTING_STARTED.md Update GETTING_STARTED.md Sep 2, 2017
License.txt Added EPL license to project root. Aug 10, 2016
OPEN_API_V3_SUPPORT.md Update OPEN_API_V3_SUPPORT.md Sep 1, 2017
README.md KZOE now requires Eclipse Oxygen or later Sep 5, 2018
TROUBLESHOOTING.md Update TROUBLESHOOTING.md May 9, 2017
pom.xml [releng] Update java runtime requirement from Java7 to Java8 Aug 9, 2018

README.md

KaiZen OpenAPI Editor Logo

KaiZen OpenAPI Editor for Eclipse

KaiZen OpenAPI Editor is an Eclipse editor for the industry standard API description language, formerly known as Swagger. It now supports both Swagger-OpenAPI version 2.0 and OpenAPI version 3.0.

KaiZen Editor is a core component of RepreZen API Studio, 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. Drag-and-drop this button into Eclipse Oxygen or later to install, or see below for other options:

Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client

NEW! OpenAPI 3.0 Editing

KaiZen OpenAPI Editor now features full support for the OpenAPI version 3.0 specification. See here for further details.

Feature Highlights

Drawing

Validation

Validation_screenshot

Code Assist

Code templates:
Code_template

Keywords and values:
CodeAssist_keys_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.

CodeAssist_for_references

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:
Navigation_to_references

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:
Navigation_to_references

Outline

Outline View shows the contents of the active OpenAPI spec:
Navigation_to_references

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 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.

Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client

Installing from the Update Site

You can install KaiZen OpenAPI Editor into your Eclipse IDE by clicking on 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 installs as a standalone desktop application on Windows, MacOS or Linux.
  • API Studio for Eclipse installs into an Eclipse IDE distribution, allowing you to use RepreZen's API design, documentation and development features in your primary Eclipse development environment.
    Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client

Troubleshooting

See the Troubleshooting Guide 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.

We also created a list of good first bugs that are relatively easy to fix.

License

KaiZen OpenAPI Editor is provided under the Eclipse Public License v1.0

Video: KaiZen Editor in RepreZen API Studio

Editing Swagger-OpenAPI in RepreZen API Studio

Note: KaiZen Editor includes code assist, real-time validation, syntax highlighting, and outline view.
Eclipse Color Theme and EditBox are available as separate plugins.
RepreZen API Studio includes the mock service, live Swagger-UI & other features that are not part of KaiZen Editor.