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

API specification formats

When defining an API, it’s important to document the definition in a way that people can understand. However, that’s not enough. API definition documents should also be understandable by code. In the end, API definition documents are meant to be interpreted and used by the software. API servers and brokers can use definition documents to programmatically make the features available to consumers and subscribers. On the other hand, consumers and subscribers can use the same documents to interact with the API producers. API definition documents are the glue between producers and consumers. There are different types of API specification formats that work well with APIs of different types. Let’s look at the most popular specification formats to understand what they are and what types of APIs you can define with them.

OpenAPI

This is probably the most popular API specification format. OpenAPI started with a different name. It was created...