swagger

package

v0.2.4 Latest Latest Go to latest Published: Apr 9, 2024 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/stevepartridge/service

Links

Open Source Insights

README ¶

Swagger Viewer

Requires Go 1.16+ to support the //go:embed functionality

Documentation ¶

Index ¶

Constants
Variables
type Swagger
- func New(mux *http.ServeMux, jsonData []byte) (*Swagger, error)
- func (s *Swagger) AddSecurityScheme(name string, scheme spec.SecurityScheme)
- func (s *Swagger) Serve()

Constants ¶

View Source

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

Variables ¶

View Source

var (
	// ErrServeMuxMustNotBeNil error
	ErrServeMuxMustNotBeNil = errors.New("swagger: serve mux can not be nil")
	// ErrJSONDataMustNotBeNil error
	ErrJSONDataMustNotBeNil = errors.New("swagger: JSON data can not be nil")
)

Functions ¶

This section is empty.

Types ¶

type Swagger ¶

type Swagger struct {
	Spec    spec.Swagger
	Schemes []string
	Path    string
	// contains filtered or unexported fields
}

Swagger holds the basic config and mux

func New ¶

func New(mux *http.ServeMux, jsonData []byte) (*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

Source Files ¶

View all Source files

swagger.go

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