doc

Documentation

Index

• Variables
• type Doc
  • func (r Doc) Body() ([]byte, error)
  • func (r Doc) Handler() http.HandlerFunc

Variables

var ErrSpecNotFound = errors.New("spec not found")

ErrSpecNotFound error for when spec file not found

var HTML string

HTML represents the openapi-ui index.html page

var JavaScript string

JavaScript represents the openapi-ui umd javascript

Types

type Doc

type Doc struct {
	DocsPath    string
	SpecPath    string
	SpecFile    string
	SpecFS      *embed.FS
	Title       string
	Description string
	Theme       string
}

Doc configuration

func (Doc) Body

func (r Doc) Body() ([]byte, error)

Body returns the final html with the js in the body

func (Doc) Handler

func (r Doc) Handler() http.HandlerFunc

Handler sets some defaults and returns a HandlerFunc