Book Image

Building an API Product

By : Bruno Pedro
Book Image

Building an API Product

By: Bruno Pedro

Overview of this book

The exponential increase in the number of APIs is evidence of their widespread adoption by companies seeking to deliver value to users across diverse industries, making the art of building successful APIs an invaluable skill for anyone involved in product development. With this comprehensive guide, you’ll walk through the entire process of planning, designing, implementing, releasing, and maintaining successful API products. You’ll start by exploring all aspects of APIs, including their types, technologies, protocols, and lifecycle stages. Next, you’ll learn how to define an API strategy and identify business objectives, user personas, and jobs-to-be-done (JTBD). With these skills, you’ll delve into designing and validating API capabilities to create a machine-readable API definition. As you advance, the book helps you understand how to choose the right language and framework for securely releasing an API server and offers insights into analyzing API usage metrics, improving performance, and creating compelling documentation that users love. Finally, you’ll discover ways to support users, manage versions, and communicate changes or the retirement of an API. By the end of this API development book, you’ll have the confidence and skills to create API products that truly stand out in the market.
Table of Contents (26 chapters)
1
Part 1:The API Product
6
Part 2:Designing an API Product
11
Part 3:Implementing an API Product
16
Part 4:Releasing an API Product
20
Part 5:Maintaining an API Product

Prototyping an API integration with a UI

At this point, your API design has been validated, and you’re ready to implement it. Almost. Before that, I want to show you that you’re still missing one type of validation that might reveal that the API design still needs to be refined. By creating a prototype of API integration with a UI, you’re able to put it in front of non-technical users to understand how they interact with it. I’m going to show you different tools and techniques to create UI prototypes that can connect to your API mock and interact with it. Let’s start with an easy approach that doesn’t require any code and uses a tool that lets anyone build web applications. Retool is a popular web application creation tool that can connect to an external API that uses the JSON response data format. With this combination, you can put together a visual UI that loads data from your API mock. The second approach uses Postman and one of its features...