swgui

README

Swagger UI

Package swgui (Swagger UI) provide a HTTP handler to serve Swagger UI. All assets are embedded in GO source code, so just build and run.

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)
}

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

• type Config

Types

type Config

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