Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Document ¶
type Document struct {
OpenAPI string `json:"openapi"`
Info Info `json:"info"`
Paths map[string]PathItem `json:"paths"`
}
Document represents an OpenAPI 3.0.3 document.
type MetaProvider ¶
MetaProvider is an optional interface endpoints can implement for OpenAPI metadata.
type Operation ¶
type Operation struct {
Summary string `json:"summary,omitempty"`
Description string `json:"description,omitempty"`
Parameters []Parameter `json:"parameters,omitempty"`
Responses map[string]Response `json:"responses"`
}
Operation describes a single API operation.
type Parameter ¶
type Parameter struct {
Name string `json:"name"`
In string `json:"in"`
Required bool `json:"required"`
Schema Schema `json:"schema"`
}
Parameter describes an operation parameter.
Click to show internal directories.
Click to hide internal directories.