swagger

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, server *echo.Server) error
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)
• type Swagger
  • func NewSwagger() *Swagger
  • func NewSwaggerWithConfigPath(path string) (*Swagger, error)
  • func NewSwaggerWithOptions(options *Options) *Swagger
  • func (i *Swagger) Register(ctx context.Context, server *echo.Server) error

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, server *echo.Server) error

Register registers a new swagger plugin for echo server.

Types

type Options

type Options struct {
	Enabled bool
	Route   string
}

Options swagger plugin for echo server options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals options based a given key path.

type Swagger

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

Swagger represents swagger plugin for echo server.

func NewSwagger

func NewSwagger() *Swagger

NewSwagger returns a new swagger plugin with default options.

func NewSwaggerWithConfigPath

func NewSwaggerWithConfigPath(path string) (*Swagger, error)

NewSwaggerWithConfigPath returns a new swagger plugin with options from config path.

func NewSwaggerWithOptions

func NewSwaggerWithOptions(options *Options) *Swagger

NewSwaggerWithOptions returns a new swagger plugin with options.

func (*Swagger) Register

func (i *Swagger) Register(ctx context.Context, server *echo.Server) error

Register registers this swagger plugin for echo server.