Providing a valid URL to a landing page for the API that is designed for humans to use when learning more about an API.
Human URL for APIs.json Contract
Rules
APIs.json APIs Human URL Info
The humanURL property for each API defined in an APIs.json contract provides a link for business or technical consumers to learn more about the API. This URL can direct users to a portal, documenta...
Strategies
APIs Have One Click Access
All APIs possess a URL for humans to follow when engaging as well as the base path URL for machines to use when calling each API, ensuring that the front door for API operations within this domain ...
Experiences
Onboarding
Transitioning from API discovery to integration as a consumer requires a well-defined and streamlined API onboarding process. Onboarding begins with discovery and relies heavily on clear documentat...
Access
Gaining the necessary access to effectively use an API is often more challenging than it appears. Intentional and unintentional barriers can create friction in discovering and onboarding with an AP...
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...
travel_explore Discovery Production
Discovery is how APIs get found and reused instead of rebuilt. APIs.json, catalogs, and search make the APIs I operate visible to the people who need them. Good discovery is what turns a pile of AP...
