swagger-ui Docker & Self-Hosted Deployment

GitHub

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

28,968 stars JavaScript JavaScript 1 file · ~2,987 tokens #hacktoberfest#oas#open-source#openapi#openapi-specification#openapi3#openapi31#rest
1. Pull Image (DOCKERHUB) docker pull swagger-api/swagger-ui:latest
2. Docker Run (1-Click Launch) docker run -d --name swagger-ui -p 8080:8080 --restart always swagger-api/swagger-ui:latest
3. Podman Run podman run -d --name swagger-ui -p 8080:8080 --restart always swagger-api/swagger-ui:latest
4. Skopeo Inspect (Zero-Pull Manifest) skopeo inspect docker://docker.io/swagger-api/swagger-ui:latest
5. ORAS Pull (OCI Artifact) oras pull swagger-api/swagger-ui:latest
Dockerfile 
# Looking for information on environment variables?
# We don't declare them here — take a look at our docs.
# https://github.com/swagger-api/swagger-ui/blob/main/docs/usage/configuration.md

FROM nginx:1.31.6-alpine

LABEL maintainer="[email protected]" \
      org.opencontainers.image.authors="[email protected]" \
      org.opencontainers.image.url="docker.swagger.io/swaggerapi/swagger-ui" \
      org.opencontainers.image.source="https://github.com/swagger-api/swagger-ui" \
      org.opencontainers.image.description="SwaggerUI Docker image" \
      org.opencontainers.image.licenses="Apache-2.0"

RUN apk add --update-cache --no-cache \
    "nodejs" \
    "libxml2>=2.13.9-r0" \
    "libexpat>=2.7.2-r0" \
    "libxslt>=1.1.42-r2" \
    "xz-libs>=5.6.3-r1" \
    "c-ares>=1.34.5-r0" \
    "libpng>=1.6.56-r0" \
    "zlib>=1.3.2-r0" \
    "libcrypto3>=3.5.6-r0" \
    "libssl3>=3.5.6-r0" \
    "musl>=1.2.5-r23" \
    "musl-utils>=1.2.5-r23" \
    "nghttp2-libs>=1.68.1-r0"

LABEL maintainer="char0n"

ENV API_KEY="**None**" \
    SWAGGER_JSON="/app/swagger.json" \
    PORT="8080" \
    PORT_IPV6="" \
    BASE_URL="/" \
    SWAGGER_JSON_URL="" \
    CORS="true" \
    EMBEDDING="false"

COPY --chmod=0644 ./docker/default.conf.template ./docker/cors.conf ./docker/embedding.conf /etc/nginx/templates/

COPY --chmod=0644 ./dist/* /usr/share/nginx/html/
COPY --chmod=0755 ./docker/docker-entrypoint.d/ /docker-entrypoint.d/
COPY --chmod=0644 ./docker/configurator /usr/share/nginx/configurator

# Simulates running NGINX as a non root; in future we want to use nginxinc/nginx-unprivileged.
# In future we will have separate unpriviledged images tagged as v5.1.2-unprivileged.
RUN chmod 777 /etc/nginx/conf.d/ /usr/share/nginx/html/ /var/cache/nginx/ /var/run/ && \
    chmod 666 /etc/nginx/conf.d/default.conf /usr/share/nginx/html/swagger-initializer.js && \
    chmod 755 /etc/nginx/templates /usr/share/nginx/configurator

EXPOSE 8080