AI engineering glossary · Web APIs HTTP

What is openAPI?

OpenAPI (also called OpenAPI Specification, Swagger): A standard, machine-readable format, written in YAML or JSON, for describing a REST API: its endpoints, parameters, request and response shapes and authentication. Tools use it to generate documentation, client libraries and tests. FastAPI produces it automatically.

Level: intermediateTopic: Web APIs HTTP

OpenAPI: an example

openapi.yaml lists GET /users/{id} with a 200 response schema, and a tool builds a Python client from it.

Related terms

More Web APIs HTTP terms

Where you learn it

OpenAPI is part of the AI Engineering Program, which teaches it with notes, a hands-on lab and an exam. The first lesson is free.

Before you go

Take the cheat sheet with you

One free PDF: the key AI-engineering terms, formulas and Python idioms. No spam; unsubscribe any time.