swagger-editor 0,6,8,2,3,0,7,4 editorconfig travis-ci docker npm webpack

Swagger Editor

Swagger-Editor

Build Status Code Climate Dependency Status devDependency Status

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

New!

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.

Running locally

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

Browser support

Swagger UI works in the latest versions of Chrome, Safari, Firefox, Edge and IE11.

Known Issues

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.

License

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.

Related Repositories

swagger-codegen

swagger-codegen

swagger-codegen contains a template-driven engine to generate documentation, API ...

swagger-node

swagger-node

Swagger module for node.js ...

swagger-express-middleware

swagger-express-middleware

Swagger middlware and mocks for Express.js and Node ...

eve-swagger

eve-swagger

Swagger extension for Eve-powered RESTful APIs ...

eve-swagger

eve-swagger

Swagger extension for Eve-powered RESTful APIs ...


Top Contributors

mohsen1 saharj MMux earth2marsh fehguy DavidBiesack webron iflamed prabhatjha dnephin chrisdudley jphastings owenconti Roobarb GerardSoleCa erichelgeson rutsky alx13 moander marcellodesales ingydotnet ddm elvisqi erictheise harry-wood igncp Brian-Williams potiuk whitlockjc joelparkerhenderson

Dependencies

package version
ajv ^5.2.2
boron ^0.2.3
bowser 1.6.1
classnames ^2.1.3
core-js ^2.4.1
immutable ^3.x.x
js-yaml ^3.5.5
json-beautify ^1.0.1
react ^15.x
react-addons-css-transition-group ^15.4.2
react-dd-menu ^2.0.0
react-dom ^15.x
react-file-download ^0.3.2
react-redux ^4.x.x
react-transition-group ^1.1.1
redux ^3.x.x
swagger-client 3.0.19
swagger-ui 3.1.3
whatwg-fetch ^2.0.3
dev autoprefixer 6.6.1
babel-core ^6.23.1
babel-eslint ^6.1.2
babel-loader ^6.3.2
babel-plugin-module-alias ^1.6.0
babel-preset-es2015 ^6.22.0
babel-preset-es2015-ie ^6.6.2
babel-preset-react ^6.23.0
babel-preset-stage-0 ^6.22.0
babel-runtime ^6.23.0
brace ^0.10.0
css-loader 0.22.0
deep-extend ^0.4.1
deepmerge ^1.3.2
eslint ^2.13.1
eslint-plugin-react ^4.3.0
expose-loader ^0.7.3
extract-text-webpack-plugin 0.8.2
file-loader 0.8.4
git-describe ^4.0.1
html-webpack-plugin ^2.28.0
http-server ^0.9.0
imports-loader 0.6.5
json-loader 0.5.3
karma ^0.13.22
karma-chrome-launcher ^0.2.3
karma-mocha ^0.2.2
karma-sourcemap-loader ^0.3.7
karma-webpack 1.8.0
less 2.5.3
less-loader 2.2.1
license-checker ^8.0.4
lodash ^4.17.4
matcher ^0.1.2
mocha ^3.2.0
npm-run-all 3.1.1
null-loader 0.1.1
open 0.0.5
postcss-loader 0.7.0
promise-worker ^1.1.1
raw-loader 0.5.1
react-ace ^4.1.6
react-hot-loader ^1.3.1
react-immutable-proptypes ^2.1.0
reselect ^2.5.4
rimraf ^2.6.0
standard ^8.6.0
standard-loader ^5.0.0
style-loader 0.13.0
url-loader 0.5.6
webpack ^1.14.0
webpack-bundle-size-analyzer ^2.5.0
worker-loader ^0.7.1
yaml-js ^0.1.4

Releases

-   v2.10.3 zip tar
-   v2.10.2 zip tar
-   v2.10.1 zip tar
-   v2.9.9 zip tar
-   v2.9.8 zip tar
-   v2.9.7 zip tar
-   v2.9.6 zip tar
-   v2.9.5 zip tar
-   v2.9.4 zip tar
-   v2.9.2 zip tar
-   v2.9.1 zip tar
-   v2.9.0 zip tar
-   v2.8.4 zip tar
-   v2.8.3 zip tar
-   v2.8.2 zip tar
-   v2.8.1 zip tar
-   v2.8.0 zip tar
-   v2.7.20 zip tar
-   v2.7.19 zip tar
-   v2.7.18 zip tar
-   v2.7.17 zip tar
-   v2.7.16 zip tar
-   v2.7.15 zip tar
-   v2.7.14 zip tar
-   v2.7.13 zip tar
-   v2.7.12 zip tar
-   v2.7.8 zip tar
-   v2.7.7 zip tar
-   v2.7.6 zip tar
-   v2.7.5 zip tar