APIs.json APIs Description Info (Edit)

The description of each API is how you make your first impression on consumers, and is what will likely show in portals, networks, search, and other ways that API consumers discover APIs and onboard with them. Make the description of an API talk about what it does, and the value it brings to consumers, not about the structure and standards used--those can be expressed in other ways. You can find details about the description property for APIs.json, and explore API descriptons more via API Evangelist.

JSON Version

YAML Version


Back to All of the Rules