Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Definition ¶
type Info ¶ added in v0.3.1
type Info struct {
Title string `json:"title,omitempty"`
Description string `json:"description,omitempty"`
Version string `json:"version,omitempty"`
Contact struct {
Email string `json:"email,omitempty"`
} `json:"contact,omitempty"`
License struct {
Name string `json:"name,omitempty"`
URL string `json:"url,omitempty"`
} `json:"license,omitempty"`
}
type Parameter ¶
type Parameter struct {
In In `json:"in,omitempty"`
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
Required bool `json:"required,omitempty"`
Type Type `json:"type,omitempty"`
Minimum float64 `json:"minimum,omitempty"`
Maximum float64 `json:"maximum,omitempty"`
Format Format `json:"format,omitempty"`
Schema []Schema `json:"schema,omitempty"`
Items struct {
Type Type `json:"type,omitempty"`
Format Format `json:"format,omitempty"`
} `json:"items,omitempty"`
CollectionFormat string `json:"collectionFormat,omitempty"`
}
type Router ¶
type Router struct {
Summary string `json:"summary,omitempty"`
Description string `json:"description,omitempty"`
Tags []string `json:"tags,omitempty"`
Consumes []string `json:"consumes,omitempty"`
Produces []string `json:"produces,omitempty"`
Parameters []Parameter `json:"parameters,omitempty"`
Responses map[string]Response `json:"responses,omitempty"`
Security []map[string][]string `json:"security,omitempty"`
}
type SecurityDefinition ¶
type Swagger ¶
type Swagger struct {
SwaggerVersion string `json:"swagger,omitempty"`
Info Info `json:"info,omitempty"`
Host string `json:"host,omitempty"`
BasePath string `json:"basePath,omitempty"`
Tags []struct {
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
ExternalDocs struct {
Description string `json:"description,omitempty"`
URL string `json:"url,omitempty"`
} `json:"externalDocs,omitempty"`
} `json:"tags,omitempty"`
Schemes []string `json:"schemes,omitempty"`
Paths map[Path]map[Method]Router `json:"paths,omitempty"`
SecurityDefinitions map[string]SecurityDefinition `json:"securityDefinitions,omitempty"`
Definitions map[string]Definition `json:"definitions,omitempty"`
ExternalDocs struct {
Description string `json:"description,omitempty"`
URL string `json:"url,omitempty"`
} `json:"externalDocs,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.