## File: README.md # [](http://badge.fury.io/js/swagger-ui) [](https://github.com/swagger-api/swagger-ui/actions/workflows/nodejs.yml) [](https://github.com/swagger-api/swagger-ui/actions/workflows/security-scan.yml) [](https://github.com/swagger-api/swagger-ui/graphs/contributors) [](https://www.npmjs.com/package/swagger-ui) [](https://bundlephobia.com/package/swagger-ui) ## Introduction [Swagger UI](https://swagger.io/tools/swagger-ui/) allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, with the visual documentation making it easy for back end implementation and client side consumption. ## General **👉🏼 Want to score an easy open-source contribution?** Check out our [Good first issue](https://github.com/swagger-api/swagger-ui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%22) label. **🕰️ Looking for the older version of Swagger UI?** Refer to the [*2.x* branch](https://github.com/swagger-api/swagger-ui/tree/2.x). This repository publishes three different NPM modules: * [swagger-ui](https://www.npmjs.com/package/swagger-ui) is a traditional npm module intended for use in single-page applications that are capable of resolving dependencies (via Webpack, Browserify, etc.). * [swagger-ui-dist](https://www.npmjs.com/package/swagger-ui-dist) is a dependency-free module that includes everything you need to serve Swagger UI in a server-side project, or a single-page application that can't resolve npm module dependencies. * [swagger-ui-react](https://www.npmjs.com/package/swagger-ui-react) is Swagger UI packaged as a React component for use in React applications. We strongly suggest that you use `swagger-ui` instead of `swagger-ui-dist` if you're building a single-page application, since `swagger-ui-dist` is significantly larger. If you are looking for plain ol' HTML/JS/CSS, [download the latest release](https://github.com/swagger-api/swagger-ui/releases/latest) and copy the contents of the `/dist` folder to your server. ## Compatibility The OpenAPI Specification has undergone 5 revisions since initial creation in 2010. Compatibility between Swagger UI and the OpenAPI Specification is as follows: | Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes | |--------------------|--------------|-------------------------------------------------------------|-----------------------------------------------------------------------| | 5.32.0 | 2026-02-27 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0, 3.1.1, 3.1.2, 3.2.0 | [tag v5.32.0](https://github.com/swagger-api/swagger-ui/tree/v5.32.0) | | 5.19.0 | 2025-02-17 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0, 3.1.1, 3.1.2 | [tag v5.19.0](https://github.com/swagger-api/swagger-ui/tree/v5.19.0) | | 5.0.0 | 2023-06-12 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | [tag v5.0.0](https://github.com/swagger-api/swagger-ui/tree/v5.0.0) | | 4.0.0 | 2021-11-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | [tag v4.0.0](https://github.com/swagger-api/swagger-ui/tree/v4.0.0) | | 3.18.3 | 2018-08-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | [tag v3.18.3](https://github.com/swagger-api/swagger-ui/tree/v3.18.3) | | 3.0.21 | 2017-07-26 | 2.0 | [tag v3.0.21](https://github.com/swagger-api/swagger-ui/tree/v3.0.21) | | 2.2.10 | 2017-01-04 | 1.1, 1.2, 2.0 | [tag v2.2.10](https://github.com/swagger-api/swagger-ui/tree/v2.2.10) | | 2.1.5 | 2016-07-20 | 1.1, 1.2, 2.0 | [tag v2.1.5](https://github.com/swagger-api/swagger-ui/tree/v2.1.5) | | 2.0.24 | 2014-09-12 | 1.1, 1.2 | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) | | 1.0.13 | 2013-03-08 | 1.1, 1.2 | [tag v1.0.13](https://github.com/swagger-api/swagger-ui/tree/v1.0.13) | | 1.0.1 | 2011-10-11 | 1.0, 1.1 | [tag v1.0.1](https://github.com/swagger-api/swagger-ui/tree/v1.0.1) | ## Anonymized analytics SwaggerUI uses [Scarf](https://scarf.sh/) to collect [anonymized installation analytics](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-what-information-does-scarf-js-send-about-me). These analytics help support the maintainers of this library and ONLY run during installation. To [opt out](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-how-can-i-opt-out-of-analytics), you can set the `scarfSettings.enabled` field to `false` in your project's `package.json`: ``` // package.json { // ... "scarfSettings": { "enabled": false } // ... } ``` Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false` as part of the environment that installs your npm packages, e.g., `SCARF_ANALYTICS=false npm install`. ## Documentation #### Usage - [Installation](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/installation.md) - [Configuration](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md) - [CORS](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/cors.md) - [OAuth2](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/oauth2.md) - [Deep Linking](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/deep-linking.md) - [Limitations](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/limitations.md) - [Version detection](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/version-detection.md) #### Customization - [Overview](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/customization/overview.md) - [Plugin API](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/customization/plugin-api.md) - [Custom layout](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/customization/custom-layout.md) #### Development - [Setting up](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/development/setting-up.md) - [Scripts](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/development/scripts.md) #### Contributing - [Contributing](https://github.com/swagger-api/.github/blob/HEAD/CONTRIBUTING.md) ##### Integration Tests End-to-end tests use [Cypress](https://www.cypress.io/). Run the full suite locally with `npm run cy:ci`, which starts the required servers, runs Cypress headless, and shuts the servers down afterwards - be sure you aren't running a dev server on the same ports when testing! To debug or run individual specs interactively, use `npm run cy:dev` to open the Cypress runner. To run a single spec headless, start the servers in one terminal and run that spec in another: ```sh npm run cy:start # in a second terminal: npm run cy:run -- --spec "test/e2e-cypress/e2e/features/deep-linking.cy.js" ``` ### Browser support Swagger UI 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. - Only part of the parameters previously supported are available. - The JSON Form Editor is not implemented. - Support for `collectionFormat` is partial. - l10n (translations) is not implemented. - Relative path support for external files is not implemented. ## Security contact Please disclose any security-related issues or vulnerabilities by emailing [security@swagger.io](mailto:security@swagger.io), instead of using the public issue tracker. ## License SwaggerUI is licensed under [Apache 2.0 license](https://github.com/swagger-api/swagger-ui/blob/main/LICENSE). SwaggerUI comes with an explicit [NOTICE](https://github.com/swagger-api/swagger-ui/blob/main/NOTICE) file containing additional legal notices and information. --- ## File: src/core/plugins/err/error-transformers/README.md # Error transformers Error transformers provide a standard interface for making generated error messages more useful to end users. ### Inputs & outputs Each transformer's `transform` function is given an Immutable List of Immutable Maps as its first argument. It is expected that each `transform` function returns a List of similarly-formed Maps. These errors originate from the Redux error actions that add errors to state. Errors are transformed before being passed into the reducer. It's important that all the keys present in each error (specifically, `line`, `level`, `message`, `source`, and `type`) are present when the transformer is finished. ##### Deleting an error If you want to delete an error completely, you can overwrite it with `null`. The null value will be filtered out of the transformed error array before the errors are returned. å ### Example transformer This transformer will increase all your line numbers by 10. ``` export function transform(errors) { return errors.map(err => { err.line += 10 return err }) } ``` --- ## File: swagger-ui-dist-package/README.md # Swagger UI Dist [](http://badge.fury.io/js/swagger-ui-dist) ## Anonymized analytics SwaggerUI Dist uses [Scarf](https://scarf.sh/) to collect [anonymized installation analytics](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-what-information-does-scarf-js-send-about-me). These analytics help support the maintainers of this library and ONLY run during installation. To [opt out](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-how-can-i-opt-out-of-analytics), you can set the `scarfSettings.enabled` field to `false` in your project's `package.json`: ``` // package.json { // ... "scarfSettings": { "enabled": false } // ... } ``` Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false` as part of the environment that installs your npm packages, e.g., `SCARF_ANALYTICS=false npm install`. # API This module, `swagger-ui-dist`, exposes Swagger-UI's entire dist folder as a dependency-free npm module. Use `swagger-ui` instead, if you'd like to have npm install dependencies for you. `SwaggerUIBundle` and `SwaggerUIStandalonePreset` can be imported: ```javascript import { SwaggerUIBundle, SwaggerUIStandalonePreset } from "swagger-ui-dist" ``` To get an absolute path to this directory for static file serving, use the exported `getAbsoluteFSPath` method: ```javascript const swaggerUiAssetPath = require("swagger-ui-dist").getAbsoluteFSPath() // then instantiate server that serves files from the swaggerUiAssetPath ``` For anything else, check the [Swagger-UI](https://github.com/swagger-api/swagger-ui) repository. --- ## File: docs/README.md # Swagger UI Welcome to the Swagger UI documentation! ## Usage - [Installation](usage/installation.md) - [Configuration](usage/configuration.md) - [CORS](usage/cors.md) - [OAuth2](usage/oauth2.md) - [Deep Linking](usage/deep-linking.md) - [Limitations](usage/limitations.md) - [Version detection](usage/version-detection.md) ## Customization - [Overview](customization/overview.md) - [Plugin API](customization/plugin-api.md) - [Custom layout](customization/custom-layout.md) - [Adding plugin](customization/add-plugin.md) - [Plug-Points](customization/plug-points.md) ## Development - [Setting up](development/setting-up.md) - [Scripts](development/scripts.md)