API Specifications & Standards
A directory of the industry-standard specifications that govern API contract definitions, message formatting, and validation grammar.
Arazzo Specification
v1.0.1A comprehensive, multi-section breakdown of the Arazzo specification, explaining workflows orchestration, input-output expressions, and state assertions.
AsyncAPI Specification
v3.0.0A deep-dive explanation of the AsyncAPI Specification, detailing message-driven architectures, channels, protocols, and event bindings.
CloudEvents
v1.0.2An overview of the CloudEvents specification, the CNCF standard for describing event data in a common, vendor-neutral format.
GraphQL
vOct 2021A query and schema definition language specification for APIs, providing a client-specified runtime to request exact data shapes.
gRPC & Protocol Buffers
vproto3 (IDL) / HTTP/2A high-performance, open-source universal RPC framework using Protocol Buffers as its interface definition and serialization language.
HAL (Hypertext Application Language)
vdraft-kelly-json-hal-11A reference for the Hypertext Application Language, a simple hypermedia format for JSON and XML APIs, covering _links, curies, _embedded resources, and a comparison with JSON:API.
HTTP Caching (RFC 9111)
vRFC 9111A reference guide to HTTP caching as defined in RFC 9111, covering freshness, validation, Cache-Control directives, the Vary header, shared versus private caches, and heuristic freshness.
HTTP Semantics (RFC 9110)
vRFC 9110The foundational reference for HTTP, RFC 9110 defines the version-independent semantics of the protocol: methods, status codes, header fields, representations, content negotiation, conditional and range requests, and the authentication framework.
HTTP/2 (RFC 9113)
vRFC 9113A reference guide to HTTP/2 as defined in RFC 9113, covering binary framing, multiplexed streams over a single connection, HPACK header compression, stream prioritization, and the transport-layer head-of-line blocking that HTTP/3 later addressed.
HTTP/3 (RFC 9114)
vRFC 9114A reference guide to HTTP/3 as defined in RFC 9114, the version of HTTP that runs over QUIC to eliminate transport-layer head-of-line blocking, with QPACK header compression, 0-RTT, connection migration, and Alt-Svc discovery.
JSON Schema in Web APIs
vDraft 2020-12An authoritative guide to JSON Schema, detailing validation vocabulary, conditional schemas, logical operators, and $ref definition resolving.
JSON Web Token (JWT)
vRFC 7519A technical reference for JSON Web Tokens, covering the header/payload/signature structure, registered claims, JWS versus JWE, signing algorithms, and common validation pitfalls.
JSON-LD & Hydra
vJSON-LD 1.1A reference for JSON-LD linked data and the Hydra vocabulary, covering @context, @id, @type, hypermedia-driven operations and collections, and a comparison with HAL and JSON:API.
A detailed breakdown of the JSON:API specification, explaining compounds documents, relations, sparse fieldsets, sorting, and pagination models.
An overview of the OData specification, covering standardized query conventions, resource modeling, and where it fits alongside ad-hoc REST APIs.
A comprehensive, multi-section guide to the OpenAPI Specification (OAS), detailing root structures, paths, component registries, and version diffs.
A reference for OpenID Connect, the identity layer on top of OAuth 2.0, covering the ID Token, the authorization code flow with PKCE, the UserInfo endpoint, discovery, and standard scopes.
A reference for the application/problem+json format, covering the standard members, extension members, and validation error patterns used to communicate HTTP API errors.
A reference for SCIM 2.0, the standard protocol for automating user and group provisioning across identity providers and applications, covering the core schema, resource endpoints, PATCH operations, and filtering.
Server-Sent Events (SSE)
vWHATWG Living StandardA practical guide to Server-Sent Events, the HTML standard for one-way server-to-client streaming over a single long-lived HTTP connection using the text/event-stream media type.
WebSocket Protocol
vRFC 6455A reference guide to the WebSocket Protocol defined in RFC 6455, covering the HTTP Upgrade handshake, full-duplex framing, subprotocols, and how it compares to SSE and HTTP polling.