API Design and Documentation
APIs are a service that your agency provides. Agencies are the API producers.
Developers, APIs users, need good, clear documentation. Common elements of API documentation include:
The goal of an API and its documentation is to stand up a utility that helps users be as self-sufficient as possible. This frees up the API producer from providing basic user support. By providing useful and commonly requested information up front, API producers allow potential API consumers to easily prototype and build new products with less friction and with more success. Learn more about the basics of APIs.
Comments
We do not screen comments before they post. Please review our commenting policy.
Content Lead:
Gray Brooks
Page Reviewed/Updated: November 28, 2012
