29K ·GitHub
What is this?
Swagger UI turns an OpenAPI (formerly Swagger) spec into interactive, visual API documentation: your team or end consumers can see and try the API's resources without any implementation logic in place.
Swagger UI turns an OpenAPI (formerly Swagger) spec into interactive, visual API documentation: your team or end consumers can see and try the API's resources without any implementation logic in place.Is it a hosted service or something I ship myself?Something you ship: a front-end library distributed as three npm packages — swagger-ui for bundler-based SPAs, dependency-free swagger-ui-dist, and swagger-ui-react as a React component — plus plain HTML/JS/CSS assets.
Something you ship: a front-end library distributed as three npm packages — swagger-ui for bundler-based SPAs, dependency-free swagger-ui-dist, and swagger-ui-react as a React component — plus plain HTML/JS/CSS assets.How do I get it running?Run npm install swagger-ui (or swagger-ui-dist if your setup can't resolve npm dependencies) and point it at your spec; for plain HTML/JS/CSS, download a release and copy the /dist folder contents to your server.
Run npm install swagger-ui (or swagger-ui-dist if your setup can't resolve npm dependencies) and point it at your spec; for plain HTML/JS/CSS, download a release and copy the /dist folder contents to your server.Do I need anything beyond a browser to view the docs?No — it's pure front-end, just assets to serve next to your spec. It works in the latest versions of Chrome, Safari, Firefox, and Edge.
No — it's pure front-end, just assets to serve next to your spec. It works in the latest versions of Chrome, Safari, Firefox, and Edge.Any known gaps I should know about?The 3.X line has documented known issues: only part of the previously supported parameters are available, the JSON Form Editor isn't implemented, collectionFormat support is partial, and l10n translations are missing.
The 3.X line has documented known issues: only part of the previously supported parameters are available, the JSON Form Editor isn't implemented, collectionFormat support is partial, and l10n translations are missing.Does the install phone home?Once: Scarf collects anonymized analytics, and only during npm installation. Opt out via scarfSettings.enabled=false in your package.json or the SCARFANALYTICS=false environment variable.
Once: Scarf collects anonymized analytics, and only during npm installation. Opt out via scarfSettings.enabled=false in your package.json or the SCARFANALYTICS=false environment variable.Is there an official Docker image?Yes — the repository ships Docker build-and-push CI workflows, so you can run Swagger UI as a container instead of copying dist assets onto a server yourself.
Yes — the repository ships Docker build-and-push CI workflows, so you can run Swagger UI as a container instead of copying dist assets onto a server yourself.Can I customize how the documentation looks?Yes — beyond configuration, the docs cover a Plugin API and custom layouts, so you can extend or replace parts of the default rendering.
Yes — beyond configuration, the docs cover a Plugin API and custom layouts, so you can extend or replace parts of the default rendering.Does it work with OAuth2-secured APIs?Yes — OAuth2 is a documented usage topic, so protected endpoints can be tried out from the UI once configured.
Yes — OAuth2 is a documented usage topic, so protected endpoints can be tried out from the UI once configured.What are similar projects?redoc, swagger-codegen, OpenAPI-Specification, fastapi, openapi-generator, apisix, scalar, swag
redoc, swagger-codegen, OpenAPI-Specification, fastapi, openapi-generator, apisix, scalar, swagWhich topics is it in?openapi-specification, swagger-ui, openapi3, api-documentation, swagger, rest, openapi, oauth2, css, browser, documentation, rest-api
openapi-specification, swagger-ui, openapi3, api-documentation, swagger, rest, openapi, oauth2, css, browser, documentation, rest-api