Swagger-Editor 3.0.7 Released!

Rebuilt dist assets to fix a flawed build in v3.0.6 - no code changes.

Swagger-Editor 3.0.6 Released!

• Improvement: new package! swagger-editor-dist is available on npm, if you have a need for the entire dist folder packaged as a dependency-free npm module.
• Bugfix: semantic validation not complaining about invalid scope references (#1259)

Swagger-Editor 3.0.5 Released!

Interface changes: None.

• Improvement: parameter and header validation now picks up type: array parameters without an items property.
• Improvement: guarding logic added to semantic validators reduces noise in the error console.
• Improvement: Standalone inherits from UI's new BaseLayout to ensure consistency between spec display in UI and Editor.
• Improvement: Clarified Docker containers to follow Docker best practices. Now latest refers to the "latest released version" and unstable refers to the current master. We will continue to tag final versions, which is, as always, the safest way to use Docker images.

Swagger-Editor 3.0.4 Released!

Interface changes: None.

• Feature: Added menu options to import from local file and URL
• Feature: Added menu option to convert JSON to YAML
• Bug: Fixed an issue where an empty spec would break rendering (#1244)

Version Diff

Swagger-Editor 3.0.3 Released!

Interface changes: None.

• Updated swagger-ui dependency to latest version

Version Diff

Swagger-Editor 3.0.2 Released!

Interface changes: None.

• Added linter and tests
• Added backward support for Swagger-Editor 2.x local storage caches
• Updated styling for better Safari support

Version Diff

Swagger-Editor 3.0.1 Released!

Interface changes: None.

• Fixed broken dev server
• Fixed CSS issues for IE11
• Reorganized NPM scripts

Version Diff

Swagger-Editor 3.0.0 Released!

Swagger-Editor

Version 3.0 brings a complete rewrite of Swagger-Editor in React.js 🎉

You should check out the Swagger-UI 3.0 release notes as well. Swagger-Editor 3 is structured as a plugin to Swagger-UI 3, so seeing what's new upstream will help understand what's going on with Swagger-Editor.

What's new?

This version is a rewrite of Swagger-Editor from the the ground up. You get the features in previous versions with benefits:

• Built using the latest technologies, based on React.js.
• Swagger-Editor is now an extension to Swagger-UI.
• Faster than before, handling larger files.
• Significantly easier to customize and extend.
• Unified UI, with the new Swagger-UI project.
• Smaller overall size of the product.
• This version will also make it easier for us to support the next versions of the spec. This version of Swagger-Editor supports version 2 of the Swagger Spec/OAS. Support for older versions have been dropped.
• Improved validation, customized validation errors, to make spec authoring easier.
• Improved auto-suggest, works both for keys and values, contextually.

Known Issues

As a fresh rewrite, some features did not make it in, notably:

• Everything listed in Swagger-UI's Known Issues.
• The integration with the codegen is still missing.
• Importing specs from a URL is not implemented.
• Many of the configuration options are not yet available.

Interface changes

Only the dom_id configuration option is supported at this time.

index.html still persists in the root of the project. Opening it directly is the quickest way to get started with Swagger-Editor!

Relationship with Swagger-UI

Swagger-Editor 3 uses Swagger-UI as a library, adding editor functionality through a set of plugins that are provided to Swagger-UI. We also provide a default layout (EditorLayout) for displaying the Editor and UI alongside each other.

Distribution files & usage

Swagger-Editor places four distribution files in its dist folder, along with a sourcemap (.map) for each file:

• swagger-editor.js: Code for the Editor without any dependencies included
• swagger-editor.css: Styling for the editor
• swagger-editor-bundle.js: Code for the editor with all dependencies included
• validation.worker.js: An external worker file for the validation engine. You won't need this unless you're trying to get validation working in a very old browser.

Developing

Run npm run dev to start a local dev server that will automatically hot reload any changes you make to Swagger-Editor.

If you'd like to develop Swagger-UI inside Swagger-Editor, you can npm link your local Swagger-UI to Swagger-Editor.

In order to persist your changes into the dist folder, npm run build must be run.

If you're modifying to suit your needs, we suggest writing a plugin and/or a custom layout instead of modifying the core code (see below!).

Prerequisites

• Node 6.x
• NPM 3.x

Extending

See Swagger-UI's section on Extending for more information.

v2.10.5

In this release we have:

• Giving the correct content-type when there is a fila parameter in the request.
• Upgrade Protractor, json-schema-view-js and some other dependencies.
• Modify the Twitter API example spec.
• Allowing non-file parameters in multipart/formdata
• Fix some eslint errors.

#1141, #1144

2.10.4

Important changes in this release:

• Showing external Docs in operation #1054
• Improvement in URL construction
• Improvements in documents ( contributing.md and CORS docs)
• Make generator.swagger.io links protocol agnostic #1069
• Submit file parameters with FormData #1070