swagger

package module

v0.0.0-...-a465f2f Latest Latest Go to latest Published: Aug 30, 2022 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/honmaple/forest-contrib

Links

Open Source Insights

Documentation ¶

Index ¶

func DeepLinking(deepLinking bool) func(c *Config)
func DocExpansion(docExpansion string) func(c *Config)
func DomID(domID string) func(c *Config)
func InstanceName(instanceName string) func(c *Config)
func New(configFns ...func(c *Config)) forest.HandlerFunc
func PersistAuthorization(persistAuthorization bool) func(c *Config)
func URL(url string) func(c *Config)
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DeepLinking ¶

func DeepLinking(deepLinking bool) func(c *Config)

DeepLinking true, false.

func DocExpansion ¶

func DocExpansion(docExpansion string) func(c *Config)

DocExpansion list, full, none.

func DomID ¶

func DomID(domID string) func(c *Config)

DomID #swagger-ui.

func InstanceName ¶

func InstanceName(instanceName string) func(c *Config)

InstanceName specified swag instance name

func New ¶

func New(configFns ...func(c *Config)) forest.HandlerFunc

New wraps `http.Handler` into `forest.HandlerFunc`.

func PersistAuthorization ¶

func PersistAuthorization(persistAuthorization bool) func(c *Config)

If set to true, it persists authorization data and it would not be lost on browser close/refresh Defaults to false

func URL ¶

func URL(url string) func(c *Config)

URL presents the url pointing to API definition (normally swagger.json or swagger.yaml).

Types ¶

type Config ¶

type Config struct {
	// The url pointing to API definition (normally swagger.json or swagger.yaml). Default is `mockedSwag.json`.
	URL                  string
	DeepLinking          bool
	DocExpansion         string
	DomID                string
	InstanceName         string
	PersistAuthorization bool
}

Config stores configuration variables.

Source Files ¶

View all Source files

swagger.go

Directories ¶

Path	Synopsis
example
docs

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL