Skip to content

Serving Swagger UI

Serve the generated OpenAPI file with an interactive UI at http://localhost:8080/swagger/index.html (the same idea as swaggo/swag's gin-swagger, but built in).

Path Content
/swagger/index.html Swagger UI
/swagger/doc.json OpenAPI 3 document

net/http

go get github.com/parvez3019/go-swagger3/swagger
package main

import (
    _ "embed"
    "log"
    "net/http"

    "github.com/parvez3019/go-swagger3/swagger"
)

//go:embed oas.json
var spec []byte

func main() {
    http.Handle("/swagger/", swagger.Handler(spec, swagger.Title("My API")))
    // your API routes...
    log.Println("Swagger UI at http://localhost:8080/swagger/index.html")
    log.Fatal(http.ListenAndServe(":8080", nil))
}

To read the spec from disk at startup instead of embedding it:

h, err := swagger.HandlerFromFile("oas.json")
if err != nil {
    log.Fatal(err)
}
http.Handle("/swagger/", h)

Framework adapters

Thin adapters wrap the core swagger.Handler. Each adapter is a separate Go module, so you only pull in the framework you use:

go get github.com/parvez3019/go-swagger3/swagger/gin
Framework Import Mount
net/http github.com/parvez3019/go-swagger3/swagger http.Handle("/swagger/", swagger.Handler(spec))
Gin .../swagger/gin r.Any("/swagger/*any", ginswagger.WrapHandler(spec))
Echo .../swagger/echo e.Any("/swagger/*", echoswagger.WrapHandler(spec))
gorilla/mux .../swagger/mux r.PathPrefix("/swagger/").Handler(muxswagger.WrapHandler(spec))
chi .../swagger/chi r.Handle("/swagger/*", chiswagger.WrapHandler(spec))
Fiber .../swagger/fiber app.All("/swagger/*", fiberswagger.WrapHandler(spec))
Hertz .../swagger/hertz see package docs
Buffalo .../swagger/buffalo see package docs
Flamingo .../swagger/flamingo http.Handler wrapper
Atreugo .../swagger/atreugo see package docs

Gin example:

import (
    "github.com/gin-gonic/gin"
    "github.com/parvez3019/go-swagger3/swagger"
    ginswagger "github.com/parvez3019/go-swagger3/swagger/gin"
)

r := gin.Default()
r.Any("/swagger/*any", ginswagger.WrapHandler(spec, swagger.Title("My API")))

Runnable samples for net/http, Gin, Echo and chi are in examples/.