I require that any event-driven or messaging interface is described with an AsyncAPI document, the same way we insist on OpenAPI for request-response APIs, so that channels, messages, and payloads are a governed contract rather than tribal knowledge. Every asynchronous API must define its channels and give its interface a proper title and version, because consumers of a message stream deserve the same legibility and tooling that HTTP consumers already take for granted. I care about this because the async side of our architecture is too often undocumented and discovered only by reading source code, which is exactly how integrations rot. AsyncAPI turns our event surface into something we can validate, publish, and reuse.
AsyncAPI Contracts Provided
Rules
AsyncAPI Info Title Error
Every AsyncAPI definition must provide a title in the info object so consumers, tooling, and discovery can identify the event-driven API by name.
AsyncAPI Channels Defined Error
Every AsyncAPI definition must define a channels object so consumers know which topics, queues, or subjects are available for publishing and subscribing to events.
Strategies
APIs Use the Right Protocol for the Job
I want us to stop treating REST as the answer to every problem and instead pick the protocol that actually fits the job in front of us. When the interaction is event-driven we describe it with Asyn...
Experiences
Contracts
Every API is a contract, and the contract experience is about how clearly the promises between provider and consumer are expressed. Technical contracts like OpenAPI and AsyncAPI describe what the A...
Interoperability
Interoperability is the experience of APIs, systems, and data working together without heroic effort. It is built on shared standards, common schema, and predictable contracts that let one system t...
Lifecycle
description Definitions Define
The definition is the contract. OpenAPI, AsyncAPI, JSON Schema, and APIs.json are the machine-readable artifacts I use to describe what an API is before, during, and after it exists. Investing in s...
