Resultado da Busca
Swagger Editor is an open source tool to design and document APIs using OpenAPI and AsyncAPI specifications. Download Swagger Editor to run locally or access on the Web, or sign up for SwaggerHub to use it in the cloud with more features and integrations.
- Download Swagger UI
Swagger UI lets you visualize and interact with the API’s...
- Swagger Editor
<iframe...
- Download Swagger UI
Swagger UI is an open source tool to visually document and interact with APIs defined with the OpenAPI Specification. You can download it from GitHub or use SwaggerHub to generate, host, and collaborate on your API definitions.
Swagger Editor is an open source tool for designing, describing, and documenting APIs using OpenAPI and AsyncAPI specifications. You can download it or try it online, and generate server stubs and client libraries for your API in any language.
- Overview
- Running locally
- Docker
- Documentation
- Security contact
- GeneratedCaptionsTabForHeroSec
⏰️ Looking for the next generation version of Swagger Editor?
SwaggerEditor is now released under two major release channels:
1.SwaggerEditor@4 - released from master branch and deployed at https://editor.swagger.io/
2.SwaggerEditor@5 - released from next branch and deployed at https://editor-next.swagger.io/
Only SwaggerEditor@5 supports OpenAPI 3.1.0. SwaggerEditor@4 will not receive OpenAPI 3.1.0 support and is considered legacy at this point. The plan is to continually migrate fully to SwaggerEditor@5 and deprecate the SwaggerEditor@4 in the future.
🕰️ Looking for the older version of Swagger Editor? Refer to the 2.x or 3.x branches.
Prerequisites
•git, any version •Node.js >=20.3.0 and npm >=9.6.7 are the minimum required versions that this repo runs on, but we always recommend using the latest version of Node.js. 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. If you'd like to make code changes to Swagger Editor, you can start up a Webpack hot-reloading dev server via npm run dev. Browser support Swagger Editor works in the latest versions of Chrome, Safari, Firefox, and Edge.
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.
Running the image from DockerHub
There is a docker image published in DockerHub. To use this, run the following: This will run Swagger Editor (in detached mode) on port 80 on your machine, so you can open it by navigating to http://localhost in your browser. •You can provide a URL pointing to an API definition (may not be available if some security policies such as CSP or CORS are enforced): •You can provide your own json or yaml definition file from your local host: Note: When both URL and SWAGGER_FILE environment variables are set, URL has priority and SWAGGER_FILE is ignored. •You can specify a different base url via BASE_URL variable for accessing the application - for example if you want the application to be available at http://localhost/swagger-editor/: •You can specify a different port via PORT variable for accessing the application, default is 8080. You can also customize the different endpoints used by the Swagger Editor with the following environment variables. For instance, this can be useful if you have your own Swagger generator server: If you want to run the Swagger Editor locally without the Codegen features (Generate Server and Generate Client) you can set the above environment variables to null (URL_SWAGGER2_CONVERTER=null).
Building and running an image locally
To build and run a docker image with the code checked out on your machine, run the following from the root directory of the project: You can then view the app by navigating to http://localhost in your browser.
Using older version of React
Important By older versions we specifically refer to React >=17 <18. By default swagger-editor@5 npm package comes with latest version of React@18. It's possible to use swagger-editor@5 npm package with older version of React. Let's say my application integrates with swagger-editor@5 npm package and uses React@17.0.2.
npm
In order to inform swagger-editor@5 npm package that I require it to use my React version, I need to use npm overrides.
yarn
In order to inform swagger-editor@5 npm package that I require it to use my specific React version, I need to use yarm resolutions.
Please disclose any security-related issues or vulnerabilities by emailing security@swagger.io, instead of using the public issue tracker.
Swagger Editor lets you edit OpenAPI API definitions in JSON or YAML format inside your browser and to preview documentations in real time. Learn how to install, run, and test Swagger Editor locally or with Docker, and check out the known issues and features.
<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-PFFSBW3" height="0" width="0" style="display:none;visibility:hidden"></iframe>
Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API. Learn how to install, configure, customize, and use Swagger UI for your API projects.
Find the latest versions of Swagger UI, a tool to generate documentation from a Swagger-compliant API. Download the assets, compare the changes, and see the bug fixes for each release.
