Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Specification

In the API world a specification is a machine-readable document that formally describes how an API behaves — its endpoints, operations, schemas, and contracts — so that humans and tooling can design, document, test, mock, and govern the API from a single shared source of truth.

A specification in the API world is a formal, machine-readable description of how an API behaves — its endpoints, operations, request and response schemas, authentication, and errors — captured in a document that both people and tooling can read. Rather than describing an API in prose, a specification turns the contract into structured data that can drive documentation, mock servers, SDK generation, testing, and governance from one source of truth.

  • A single source of truth - One artifact the whole lifecycle references, so design, docs, and code stay aligned instead of drifting apart.
  • Machine-readable contract - Structured enough that tooling can validate, mock, and generate against it without a human in the loop.
  • A family, not one format - OpenAPI, AsyncAPI, JSON Schema, and Arazzo each specify different facets of API behavior.
  • Governable - Because it is data, a specification can be linted and enforced with tools like Spectral.

Specifications are the backbone of how I evaluate and score APIs, because an accurate spec is what makes an API discoverable, testable, and reusable rather than a black box. As I have written, the landscape is fragmented and politically fraught, and specs rot when they drift from the running API — but that same machine-readable contract is exactly what the agentic turn depends on, since an AI agent needs a precise description of an API before it can safely call it.

Referenced on the API Evangelist blog

Where this standard shows up across sixteen years of my writing at apievangelist.com — how it fits into API design, governance, and the agentic turn.