OpenAPI operation
One method on one path in an OpenAPI document, such as get on /tasks, with its parameters, request body, possible responses and security requirements.
In more detail
Each operation should list its failure responses as carefully as its success, give every parameter a location, type and bounds, and carry a stable operationId that tools use as a function name. Operations are grouped under paths, one per HTTP method.
Related terms
- OpenAPI — A standard, language-neutral format for describing an HTTP API: its paths, operations, parameters, request and response schemas, errors and security.
- HTTP method — The verb at the start of a web request that says what the client wants, such as GET to read or POST to create.
- JSON Schema — A standard vocabulary for describing the allowed shape of JSON data: which fields exist, their types, which are required and what values are allowed.
Taught in
- What An API Is, And The Alternatives — Modern API Architecture: REST, GraphQL & gRPC
- OpenAPI And Design-First — Modern API Architecture: REST, GraphQL & gRPC
- Contract Testing — Modern API Architecture: REST, GraphQL & gRPC