README
¶
Swagger UI
Package swgui (Swagger UI) provides HTTP handler to serve Swagger UI.
All assets are embedded in Go source code, so just build and run.
Static assets for v3 are built from Swagger UI v3.38.0.
CDN-based v3cdn uses Swagger UI v3.38.0.
How to use
package main
import (
"net/http"
"github.com/swaggest/swgui/v3"
)
func main() {
http.Handle("/", v3.NewHandler("My API", "/swagger.json", "/"))
http.ListenAndServe(":8080", nil)
}
Use CDN for assets
In order to reduce binary size you can import github.com/swaggest/swgui/v3cdn to use CDN hosted assets.
Also you can use swguicdn build tag to enable CDN mode for github.com/swaggest/swgui/v3 import.
Be aware that CDN mode may be considered inappropriate for security or networking reasons.
Run as standalone server
Install swgui-server
go get github.com/swaggest/swgui/...
Start server
swgui-server -port 8080
Documentation
¶
Overview ¶
Package swgui provide a http FileSystem handler for swagger UI interface
How to generate asset files:
1. Install tools:
go get -u github.com/shurcooL/vfsgen
2. Generate file:
At root folder, run command:
go generate
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v1.0.0
type Config struct {
Title string `json:"title"` // title of index file
SwaggerJSON string `json:"swaggerJsonUrl"` // url to swagger.json document specification
BasePath string `json:"basePath"` // base url to docs
ShowTopBar bool `json:"showTopBar"` // Show navigation top bar, hidden by default
JsonEditor bool `json:"jsonEditor"` // Enable visual json editor support (experimental, can fail with complex schemas)
PreAuthorizeApiKey map[string]string `json:"preAuthorizeApiKey"` // Map of security name to key value
}
Config is used for Swagger UI handler configuration
Source Files
Directories