Describe a service interface
Make an HTTP service’s operations and inputs understandable to callers.
Desired outcome
A documented contract for calling an HTTP service.
Explore from the outcome
Where this function can lead
These documented connections are starting points for selection, not a ranked list.
Ways to do it
Methods that can help achieve this outcome.
- API contract description
Describe HTTP operations, parameters, and data shapes in a shared interface format.
Link evidence: OpenAPI Specification v3.2.1
Specifications and guidance
Standards and frameworks relevant to the work.
- OpenAPI Specification 3.2.1
Specification for describing HTTP APIs in a language-independent form.
Link evidence: OpenAPI Specification v3.2.1
Typical inputs
- Service operations and data shapes
Typical outputs
- Machine-readable API description
Sources
Last reviewed 2026-09-30