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

Generating server code from a specification

In Chapter 8, you learned how to translate your API definition into a machine-readable document that can be used, among other things, to generate server and client code. You examined different specifications and had the chance to understand their differences. Now is the time to take one machine-readable document and convert it into code that runs and powers your API server. This code is meant to act as the prototype of your API because it doesn’t include any business logic.

We’ll focus on one of the specification formats and one of the programming languages. I’ll use the OpenAPI specification format and the Node.js programming language to show you how you can quickly get your API server up and running.

Now, let’s see how you can generate server code using two different approaches. The first approach uses Postman, a popular API platform, so that you can go from your OpenAPI definition document to a fully working...