openapi

README

Swagger Viewer

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

Documentation

Index

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

Constants

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

Variables

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

Types

type OpenAPI

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

OpenAPI holds the basic config and mux

func New

func New(mux *http.ServeMux, jsonData []byte) (*OpenAPI, error)

New initiates openapi server

func (*OpenAPI) AddSecurityScheme

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

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

func (*OpenAPI) Serve

func (s *OpenAPI) Serve()

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