All terms

OpenAPI

OpenAPI is a machine-readable schema describing every endpoint, parameter and response of a REST API, from which clients can be generated.

In detail

This API publishes an OpenAPI 3.1 document alongside an llms.txt index, which is what lets an SDK generator, a Postman collection or an agent framework understand the surface without anyone reading prose first. It is the source of truth for request shapes and status codes. Behaviour changes are announced on the changelog before they ship, so a generated client can be regenerated deliberately rather than discovered broken.

Also known as

  • swagger
  • api schema

Related terms