Documentation
¶
Index ¶
Constants ¶
View Source
const ExternalConfigName = "apidocs"
ExternalConfigName is the external config name of apidocs.
Variables ¶
This section is empty.
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.
Source Files
Click to show internal directories.
Click to hide internal directories.