Approaches

API contract description

Describe HTTP operations, parameters, and data shapes in a shared interface format.

When to consider it

  • When a service needs a discoverable and testable interface contract

Considerations

  • A description does not prove that an implementation behaves as documented.

Connections

Sources

  1. OpenAPI Specification v3.2.1OpenAPI Initiative · checked 2026-09-30

Last reviewed 2026-09-30