From the course: Introduction to Web APIs

Unlock the full course today

Join today to access over 24,000 courses taught by industry experts.

API documentation

API documentation - REST Tutorial

From the course: Introduction to Web APIs

Start my 1-month free trial Buy for my team

API documentation

“

- [Narrator] The starting point for working with any API is the documentation. Any good API should have good documentation explaining how to work with it. Good documentation can provide lots of information. It should describe the basics of what the API does, what type of data can you get from it? It should explain the requirements for using the API. Is it free or paid? Does it require you to register and obtain a key? It should also provide examples of how to make the request and the responses returned. And most importantly, for actually working with the API, it should provide you with endpoints and parameters. Endpoints tell you the different places you can connect to the API. Endpoints are URLs. In the end of each URL connects you to specific data options from the API. If we think back to our restaurant analogy, we can think of endpoints like the different parts of a menu. A menu has different locations like…

Contents