middleware

Documentation

Index

• Variables
• type OpenApiMiddleware
  • func NewOpenApiMiddleware(hasLicenseFile bool, licenseFileContent []byte) *OpenApiMiddleware
  • func (o *OpenApiMiddleware) DoInitOnce()
  • func (o *OpenApiMiddleware) Router(ctx *fw.MiddlewareContext) []*fw.RouteItem
  • func (o *OpenApiMiddleware) SetDocContent(docContent []byte)
• type OpenApiOptions

Variables

var FS embed.FS

var RAPIFS embed.FS

Types

type OpenApiMiddleware

type OpenApiMiddleware struct {
	*fw.MiddlewareGlobal
	// contains filtered or unexported fields
}

func NewOpenApiMiddleware

func NewOpenApiMiddleware(hasLicenseFile bool, licenseFileContent []byte) *OpenApiMiddleware

func (*OpenApiMiddleware) DoInitOnce

func (o *OpenApiMiddleware) DoInitOnce()

func (*OpenApiMiddleware) Router

func (o *OpenApiMiddleware) Router(ctx *fw.MiddlewareContext) []*fw.RouteItem

func (*OpenApiMiddleware) SetDocContent

func (o *OpenApiMiddleware) SetDocContent(docContent []byte)

type OpenApiOptions

type OpenApiOptions struct {
	Redirect bool `yaml:"redirect" default:"true"` //if redirect /doc to /doc/index.html
	//Route    string `yaml:"route" default:"doc"`             // the page route of openapi document. e.g. if your want to serve document at /docA/index.html, just set route to docA
	FileName string `yaml:"fileName" default:"openapi.yaml"` //file path refer to openapi.yaml or openapi.json
	Type     string `yaml:"type" default:"swagger"`          //ui type. swagger\rapi
}