Module 2 of 6Lesson 1 of 2~16 min
Reading a REST API's documentation
API documentation looks technical, but it answers very concrete questions for a PM. This lesson teaches you to find what matters in it, from endpoints to data formats, and then to work out for a given flow which calls you need and what to ask the vendor.
Lesson objective
By the end of this lesson, you will be able to read a REST API's documentation (resources, endpoints, methods, parameters, JSON bodies, OpenAPI description) and extract, for a given flow, the calls needed, the required fields and the questions to ask the publisher.
Topics covered
- REST API
- API documentation
- endpoints
- OpenAPI
- JSON
In the glossary
Where it fits
Reading an API
How do I read an API's documentation and understand what it answers, including when things fail?
Lessons in this module
- Reading a REST API's documentation (this lesson)
- Status codes, errors and product decisions
What you will learn in this module
This lesson is part of the course Design and test an API integration as a PM
- Read a REST API's documentation (resources, endpoints, methods, parameters, JSON bodies, OpenAPI description) and extract what the integration needs.
- Interpret status codes and error responses, and decide the product behavior (fix, retry, alert, inform the user).
Related courses
- Product ManagementAdvancedRegular practice: you already use the tools or work on this topic.
Git for PMs: ship as a team without putting production at risk
3 hr 30 min
- Tech for PMsAll levelsNo prerequisites: accessible to everyone.
Explain how a web product works, from browser to server
2 hr 30 min
- Tech for PMsJuniorSome basics are useful: introductory knowledge of the topic.
Model your product’s data and query it with SQL
3 hr 30 min