Tag Archives: api documentation

What Skills Do Your APIs Offer?

Much has been written about API design techniques – from choosing the right HTTP verb to guidance on response code usage and hypermedia dos and don’ts. We get caught up in the technical details of what our API should look like under the covers, while ignoring the humans that the APIs were designed to help. […]

Comments Off on What Skills Do Your APIs Offer?
Asking for help with your startup

Building Your API Documentation Strategy For SUCCESS

So far, we have put together a foundation for our API documentation: 1. We must first move beyond API reference documentation and look for other ways to communicate the value and purpose of your APIs 2. APIs are conversations between client and server.¬†Extending these conversations is important and documentation can help surface opportunities and gaps […]

Comments Off on Building Your API Documentation Strategy For SUCCESS
Common Questions for API Documentation

10 Questions Your API Documentation Must Answer

Effective communication is the most important factor for API success. APIs do not have a user interface, so your documentation is the primary communication method for developers to interact with your API. As my API training partner Keith Casey states, “Documentation is the third user interface for APIs, and the most important”. Your API Documentation […]

Comments Off on 10 Questions Your API Documentation Must Answer

Moving Beyond API Reference Documentation

“Great API documentation is essential” many people exclaim. So, you fire up your favorite API definition editor and¬†start writing docs. You learn what YAML is and how to format it properly. You agonize over the URL paths, verbs, response codes, and payload definitions. Finally, you reach that glorious moment: “Documentation is done! Whew!” Not quite. […]

Comments ( 1 )