API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Descriptions for APIs

Providing a robust description of each API, providing the right amount of information for consumers to understand what is possible and what the business use case is.

Rules

APIs.json APIs Description Info

Each API included in an APIs.json file needs a 1-3 paragraph description. This description serves as the first impression for potential consumers and is often displayed in portals, networks, search...

Strategies

APIs Are Discoverable Through a Central Catalog

If people can't find your APIs, they will build their own--and that is how duplication spirals out of control. A central catalog with consistent metadata, tags, and descriptions is one of the most ...