OpenAPI

noun

say it: “OH-pun AY-PEE-EYE” /ˈoʊpən ˌeɪ piː ˈaɪ/

A standard, machine-readable description of a web API: its endpoints, inputs and responses.

What is OpenAPI?

OpenAPI is a standard JSON or YAML description of an API: its endpoints, parameters, bodies and responses. Tools use it to make docs, test requests and generate client code.

In a sentence

  • “Our OpenAPI document lets other teams generate a client for our API.”

Level: Journeyman · More REST API terms at this level

Updated

In other subjects