swagger

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 17, 2020 License: MIT Imports: 14 Imported by: 0

Documentation

Overview

Code generated for package swagger by go-bindata DO NOT EDIT. (@generated) sources: swagger/ui/favicon-16x16.png swagger/ui/favicon-32x32.png swagger/ui/index.html swagger/ui/oauth2-redirect.html swagger/ui/swagger-ui-bundle.js swagger/ui/swagger-ui-bundle.js.map swagger/ui/swagger-ui-monokai.css swagger/ui/swagger-ui-standalone-preset.js swagger/ui/swagger-ui-standalone-preset.js.map swagger/ui/swagger-ui.css swagger/ui/swagger-ui.css.map swagger/ui/swagger-ui.js swagger/ui/swagger-ui.js.map

Index

Constants

View Source
const (
	// DefaultPath is root path docs will be served up unless configured differently
	DefaultPath = "/docs"
)

Variables

This section is empty.

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type Swagger

type Swagger struct {
	Title    string
	Version  string
	Schemes  []string
	JSONData []byte
	Path     string
	// contains filtered or unexported fields
}

Swagger holds the basic config and mux

func New

func New(mux *chi.Mux) (*Swagger, error)

New initiates swagger server

func (*Swagger) AddSecurityScheme

func (s *Swagger) AddSecurityScheme(name string, scheme spec.SecurityScheme)

AddSecurityScheme is a helper to add security schemes such as OAuth2, etc.

func (*Swagger) Serve

func (s *Swagger) Serve()

Serve handles the docs, swagger.json, and server.js

Jump to

Keyboard shortcuts

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