swaggeruiemb

Overview ¶

Package swaggeruiemb provides an embedded (air-gapped) Swagger UI for stdocs.

Unlike the sibling ui/swaggerui package, which loads Swagger UI from a CDN at page-load time, ui/swaggeruiemb vendors the Swagger UI JavaScript and CSS in your binary so the docs UI works without an internet connection.

The vendored bundle is pinned to swagger-ui-dist@5.32.6 and its sha384 SRI hash is set in the sibling ui/swaggerui package.

To use it:

import (
    "net/http"
    "github.com/FumingPower3925/stdocs"
    "github.com/FumingPower3925/stdocs/ui/swaggeruiemb"
)

mux := stdocs.New(stdocs.WithTitle("My API"), swaggeruiemb.WithUI())
mux.HandleFunc("GET /x", h)
mux.Mount() // registers the docs AND the embedded asset route

Mount registers the asset route automatically (and tolerates a pre-existing manual registration). Only a manually mounted docs handler needs its own asset registration:

mux.ServeMux.Handle("GET /docs/", mux.Docs())
mux.ServeMux.Handle("GET /docs/_assets/", http.StripPrefix(
    "/docs/_assets/", swaggeruiemb.AssetHandler()))

The asset handler adds about 1.7 MB to your binary and is only included if you import this sub-package.