Consider the following scenario that all developers will be familiar with: You are writing code to call a web API (let’s go with Instagram). You consult Instagram’s online API documentation which lists all available endpoints. For each endpoint, you observe the query and payload parameters – cool. However, if you have never invoked the API and don’t know exactly what endpoint you are looking for, it is tedious to navigate through the 30+ provided endpoints. In addition, even when you select the endpoint that appears to do what you need, what value should you use for each query parameter or the request payload?
When searching for a usage example of a specific API endpoint, a textual search like
See for yourself. Checkout a couple of examples from popular web APIs on API Harmony:
Did you learn something new about the above APIs? How would you make use of this information as a developer to improve your development workflow and efficiency? Let’s discuss below!