Swagger Editor lets you edit Swagger API specifications in YAML inside your browser and to preview documentations in real time. Valid Swagger JSON descriptions can then be generated and used with the full Swagger tooling (code generation, documentation, etc).
This is the new version of swagger-editor, 3.x. Want to learn more? Check out our FAQ.
As a brand new version, written from the ground up, there are some known issues and unimplemented features. Check out the Known Issues section for more details.
For the older version of swagger-editor, refer to the 2.x branch.
- Node 6.x
- NPM 3.x
If you have Node.js and npm installed, you can run
npm start to spin up a static server.
Otherwise, you can open
index.html directly from your filesystem in your browser.
Swagger UI works in the latest versions of Chrome, Safari, Firefox, Edge and IE11.
To help with the migration, here are the currently known issues with 3.X. This list will update regularly, and will not include features that were not implemented in previous versions.
- Everything listed in Swagger-UI’s Known Issues.
- The integration with the codegen is still missing.
- Importing specs from a URL is not implemented.
Copyright 2017 SmartBear Software
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.