OpenAPI Specification
- Category
- Data and API specs
- Docs outline
- 12 sections
Official docs outline
spec.openapis.org- OpenAPI object
Root document fields: openapi, info, servers, paths, components.
- Info and Server objects
API metadata and server URLs with variables.
- Paths and Path Item objects
Mapping URL templates to operations.
- Operation object
operationId, tags, parameters, requestBody, responses and security.
- Parameter object
Path, query, header and cookie parameters and serialization styles.
- Request body and media types
Request bodies, content maps and encoding.
- Responses object
Status code keyed responses and default.
- Components object
Reusable schemas, parameters, responses, headers and security schemes.
- Schema object
JSON Schema based modeling and discriminator.
- Reference object
$ref usage for reusing components.
- Security scheme and OAuth flows
apiKey, http, oauth2 and openIdConnect schemes.
- Callbacks
Describing out-of-band callback requests.
Each section links to the official page. Titles and summaries by Extra Credit; the docs belong to their authors.