# Swagger-UI

Swagger-UI is a self-hosted development app. Swagger UI lets your development team and end users visualize and interact with an API's resources without any implementation logic in place. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/353/swagger-ui

## Description

Swagger UI lets your development team and end users visualize and interact with an API's resources without any implementation logic in place. It is automatically generated from your OpenAPI (formerly Swagger) Specification, and the visual documentation makes back-end implementation and client-side consumption easier.

## Platform availability

Available on 2 of 9 platforms: Unraid, Helm.

## Links

- Docker Hub: https://hub.docker.com/r/swaggerapi/swagger-ui
- Official website: https://swagger.io/
- Unraid: https://ca.unraid.net/apps/swagger-ui-15w2it117tbfc1?q=Swagger-UI
- Documentation: https://swagger.io/docs/
- GitHub: https://github.com/swagger-api/swagger-ui

## Common questions

### How do I document an existing API with Swagger UI?

It usually means pointing Swagger UI at a generated Swagger document, and the approach depends on the API framework.

### Why can Swagger UI show a blank page in an internal environment?

Swagger UI may depend on external internet access, and the /docs page can fail silently when that access is unavailable. Host the Swagger UI assets locally and point the application code to them.

### What files do I serve when self-hosting Swagger UI?

Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate documentation from a Swagger-compliant API.

## Alternatives

- Doxygen: Doxygen is a tool for generating documentation from annotated C++ sources, as well as other popular programming languages like C, Objective…

---
Source: Our Local Host (https://ourlocalhost.com/app/353/swagger-ui), the self-hosted and open-source app directory.