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

Support channels

The best way to provide support is by giving users a way to find the answers to the issues they’re having. This type of support channel is called a knowledge base, and its goal is to become the source of truth (SOT) to all questions that users might have. However, there’s a fine balance between what you provide on a knowledge base and how much you invest in interactive support—where real people are involved. Lean too much on a knowledge base, and you lose a sense of what challenges users are having and oftentimes make them feel frustrated when they can’t find an answer tailored to their problems. Spend too little on a knowledge base, and you end up repeating the same answers to users who have similar issues.

The ideal scenario is a combination of a knowledge base with other support channels. Let’s first see how you can create and grow a productive knowledge base that helps users and also your own support team. The most basic knowledge...