swag Docker & Self-Hosted Deployment

GitHub

Automatically generate RESTful API documentation with Swagger 2.0 for Go.

12,862 stars Go Go 1 file · ~28,412 tokens #annotations#golang#openapi#swagger#swagger2
1. Pull Image (DOCKERHUB) docker pull swaggo/swag:latest
2. Docker Run (1-Click Launch) docker run -d --name swag --restart always swaggo/swag:latest
3. Podman Run podman run -d --name swag --restart always swaggo/swag:latest
4. Skopeo Inspect (Zero-Pull Manifest) skopeo inspect docker://docker.io/swaggo/swag:latest
5. ORAS Pull (OCI Artifact) oras pull swaggo/swag:latest
Dockerfile 
# Dockerfile References: https://docs.docker.com/engine/reference/builder/

# Start from the latest golang base image
FROM --platform=$BUILDPLATFORM golang:1.24-alpine as builder

# Set the Current Working Directory inside the container
WORKDIR /app

# Copy go mod and sum files
COPY go.mod go.sum ./

# Download all dependencies. Dependencies will be cached if the go.mod and go.sum files are not changed
RUN go mod download

# Copy the source from the current directory to the Working Directory inside the container
COPY . .

# Configure go compiler target platform
ARG TARGETOS
ARG TARGETARCH
ENV GOARCH=$TARGETARCH \
    GOOS=$TARGETOS

# Build the Go app
RUN CGO_ENABLED=0 GOOS=linux go build -v -a -installsuffix cgo -o swag cmd/swag/main.go


######## Start a new stage from scratch #######
FROM --platform=$TARGETPLATFORM scratch

WORKDIR /code/

# Copy the Pre-built binary file from the previous stage
COPY --from=builder /app/swag /bin/swag

ENTRYPOINT ["/bin/swag"]