dochandler

Documentation

Index

• Constants
• func ListEndpointHandler(doc *openapi3.T, extras ...Endpoint) http.HandlerFunc
• func New(doc *openapi3.T, basePath string, info *info.Info, mdtext string) http.Handler
• func OpenAPIDocHandler(doc *openapi3.T) http.HandlerFunc
• func RedocHandler(doc *openapi3.T, basePath string) http.HandlerFunc
• func SwaggerUIHandler(doc *openapi3.T, basePath string) http.HandlerFunc
• type Endpoint
  • func (r *Endpoint) String() string
• type MDDocHandler
  • func NewMdDocHandler(doc *openapi3.T, info *info.Info) *MDDocHandler
  • func (h *MDDocHandler) HTML(w http.ResponseWriter, r *http.Request)
  • func (h *MDDocHandler) Text(w http.ResponseWriter, r *http.Request)

Constants

const MDDOC_TEMPLATE = `` /* 2871-byte string literal not displayed */

const REDOC_TEMPLATE = `` /* 566-byte string literal not displayed */

const SWAGGER_UI_TEMPLATE = `` /* 787-byte string literal not displayed */

Functions

func ListEndpointHandler

func ListEndpointHandler(doc *openapi3.T, extras ...Endpoint) http.HandlerFunc

func New

func New(doc *openapi3.T, basePath string, info *info.Info, mdtext string) http.Handler

func OpenAPIDocHandler

func OpenAPIDocHandler(doc *openapi3.T) http.HandlerFunc

func RedocHandler

func RedocHandler(doc *openapi3.T, basePath string) http.HandlerFunc

func SwaggerUIHandler

func SwaggerUIHandler(doc *openapi3.T, basePath string) http.HandlerFunc

Types

type Endpoint

type Endpoint struct {
	Method      string `json:"method"`
	Path        string `json:"path"`
	OperationID string `json:"operationId"`
	Summary     string `json:"summary"`
}

func (*Endpoint) String

func (r *Endpoint) String() string

type MDDocHandler

type MDDocHandler struct {
	// contains filtered or unexported fields
}

func NewMdDocHandler

func NewMdDocHandler(doc *openapi3.T, info *info.Info) *MDDocHandler

func (*MDDocHandler) HTML

func (h *MDDocHandler) HTML(w http.ResponseWriter, r *http.Request)

func (*MDDocHandler) Text

func (h *MDDocHandler) Text(w http.ResponseWriter, r *http.Request)