OpenAPI Specification

Noun · Development

Definitions

  1. A language-agnostic standard for describing REST APIs in YAML or JSON format -- endpoints, parameters, request/response schemas, authentication, and examples. Formerly known as Swagger. Enables auto-generated documentation (Swagger UI, Redoc), client SDK generation, server stub generation, and API testing. The industry standard for API contracts.

    In plain English: A standard format for describing REST APIs that enables auto-generated docs, client libraries, and testing tools.

    Example: "Write the OpenAPI spec first, generate the server stubs and TypeScript client -- the spec is the single source of truth for the API contract."

Related Terms