Documentation
¶
Index ¶
Constants ¶
View Source
const DefaultOverridesFile = ".swaggo"
DefaultOverridesFile is the location swaggo will look for type overrides.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v1.7.7
type Config struct {
// SearchDir the swag would be parse,comma separated if multiple
SearchDir string
// excludes dirs and files in SearchDir,comma separated
Excludes string
// OutputDir represents the output directory for all the generated files
OutputDir string
// MainAPIFile the Go file path in which 'swagger general API Info' is written
MainAPIFile string
// PropNamingStrategy represents property naming strategy like snake case,camel case,pascal case
PropNamingStrategy string
// MarkdownFilesDir used to find markdown files, which can be used for tag descriptions
MarkdownFilesDir string
// CodeExampleFilesDir used to find code example files, which can be used for x-codeSamples
CodeExampleFilesDir string
// InstanceName is used to get distinct names for different swagger documents in the
// same project. The default value is "swagger".
InstanceName string
// ParseDepth dependency parse depth
ParseDepth int
// ParseVendor whether swag should be parse vendor folder
ParseVendor bool
// ParseDependencies whether swag should be parse outside dependency folder
ParseDependency bool
// ParseInternal whether swag should parse internal packages
ParseInternal bool
// Strict whether swag should error or warn when it detects cases which are most likely user errors
Strict bool
// GeneratedTime whether swag should generate the timestamp at the top of docs.go
GeneratedTime bool
// OverridesFile defines global type overrides.
OverridesFile string
}
Config presents Gen configurations.
Click to show internal directories.
Click to hide internal directories.