Documentation
¶
Index ¶
- func MarshalDoc(headers map[string][]string, info Info, server string, ...) ([]byte, string)
- func MarshalJson(info Info, server string, r ...resource.Resource) ([]byte, error)
- func MarshalYaml(info Info, server string, r ...resource.Resource) ([]byte, error)
- type Components
- type Content
- type DataObject
- type Info
- type License
- type Operation
- type Parameter
- type Path
- type RefSchema
- type Schema
- type Server
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MarshalDoc ¶
func MarshalJson ¶
Types ¶
type Components ¶
type Content ¶
type Content struct {
Schema RefSchema `json:"schema,omitempty" yaml:"schema,omitempty"`
}
type DataObject ¶
type Info ¶
type Info struct {
Title string `json:"title"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
TermsOfService string `json:"termsOfService,omitempty" yaml:"termsOfService,omitempty"`
Contact map[string]string `json:"contact,omitempty" yaml:"contact,omitempty"`
License *License `json:"license,omitempty" yaml:"license,omitempty"`
Version string `json:"version"`
}
type Operation ¶
type Operation struct {
Description string `json:"summary,omitempty" yaml:"summary,omitempty"`
Responses map[string]DataObject `json:"responses,omitempty" yaml:"responses,omitempty"`
QueryParameters []Parameter `json:"parameters,omitempty" yaml:"parameters,omitempty"`
RequestBody *DataObject `json:"requestBody,omitempty" yaml:"requestBody,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.