Providing a robust description of the API contract, as well as each API it contains, providing my context for stakeholders of the contract.
Descriptions for APIs.json Contracts
Rules
APIs.json Description Info
Every collection of APIs defined in APIs.json should include a one- or two-paragraph description outlining the purpose of the APIs. While individual APIs should have their own descriptions, the col...
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...
menu_book Documentation Beta
Documentation is the API for humans. I generate reference docs from the definition and surround them with the guides, examples, and getting-started material that turn a spec into understanding. Doc...
