swaggerui

Overview ¶

Package swaggerui provides a Swagger UI for stdocs.

Swagger UI is the classic OpenAPI viewer, loaded from a CDN. To use it, import this sub-package and pass swaggerui.WithUI() to stdocs.New or stdocs.DocsHandler:

import (
    "github.com/FumingPower3925/stdocs"
    "github.com/FumingPower3925/stdocs/ui/swaggerui"
)

mux := stdocs.New(stdocs.WithTitle("My API"), swaggerui.WithUI())
mux.HandleFunc("GET /x", h)
mux.Mount()

This sub-package adds the Swagger UI HTML to the docs handler. The Swagger UI JavaScript and CSS are loaded from cdn.jsdelivr.net at page load time, so an internet connection is required.

The CDN URLs are pinned to a specific version (5.32.6, the current latest 5.x). Integrity hashes are pre-computed (sha384) and pinned in the <link>/<script> tags. Bumping the pinned version requires re-computing the hashes; see CONTRIBUTING.md for the procedure.