Documentation
¶
Overview ¶
Package parser loads an OpenAPI 3.x spec and extracts a flat representation suited for static HTML rendering.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Doc ¶
Doc is the parsed representation of an OpenAPI spec, ready for rendering.
type Endpoint ¶
type Endpoint struct {
Method string // uppercase: GET, POST, …
Path string
Summary string
Description string
Deprecated bool
Parameters []Parameter
RequestBody *Body
Responses []Response
}
Endpoint is a single HTTP operation.
type Parameter ¶
type Parameter struct {
Name string
In string // path, query, header, cookie
Required bool
Description string
Schema *Schema
}
Parameter is a path/query/header/cookie parameter.
Click to show internal directories.
Click to hide internal directories.