apidocs

Documentation

Index

• Constants
• func Default() nirvana.Configurer
• func Disable() nirvana.Configurer
• func Files(files map[string]string) nirvana.Configurer
• func Path(path string) nirvana.Configurer
• type Option
  • func NewDefaultOption() *Option
  • func (p *Option) Configure(cfg *nirvana.Config) error
  • func (p *Option) Name() string

Constants

const ExternalConfigName = "apidocs"

ExternalConfigName is the external config name of apidocs.

Functions

func Default

func Default() nirvana.Configurer

Default Configurer does nothing but ensure default config was set.

func Disable

func Disable() nirvana.Configurer

Disable returns a configurer to disable current plugin for a certain nirvana server.

func Files

func Files(files map[string]string) nirvana.Configurer

Files Configurer sets apidocs files config.

func Path

func Path(path string) nirvana.Configurer

Path returns a configurer to set apidocs path.

Types

type Option

type Option struct {
	Path      string `desc:"Path to the API documentation page, default: /docs"`
	FilesPath string `desc:"The folder path that contains all swagger JSON files, default: apis"`
}

Option contains basic configurations of apidocs.

func NewDefaultOption

func NewDefaultOption() *Option

NewDefaultOption creates default option.

func (*Option) Configure

func (p *Option) Configure(cfg *nirvana.Config) error

Configure configures nirvana config via current options.

func (*Option) Name

func (p *Option) Name() string

Name returns plugin name.