Concept · Technical basics

OpenAPI

Also called: OpenAPI spec, OpenAPI specification, Swagger, API spec

A standard format for describing what an API offers: its addresses, what each one expects and what it returns. Tools can read the description to generate documentation, test code or AI tool definitions.

For example: A team publishes an OpenAPI file for its REST API, and partners generate working client code from it.

Connects to 4

Page last changed · Suggest a correction