Sign In Start Free Trial
Account

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying Building an API Product
  • Table Of Contents Toc
Building an API Product

Building an API Product

By : Bruno Pedro
4.9 (7)
close
close
Building an API Product

Building an API Product

4.9 (7)
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)
close
close
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

Breaking changes

You can identify changes between different API versions reactively by running integration tests and seeing which features fail. However, that’s not the best way to identify what changed – or what will change – between two API versions. There’s a proactive approach you can follow even before you write any code. After you re-design your API and update your machine-readable definition document, you can compare it to the one from a previous version. Because the document is machine-readable, it’s easy to feed it to a tool that calculates the differences between both versions. This type of tool generates what we call an API diff.

API diffs are usually lists of differences between two JSON documents. Here’s an example output from oasdiff, a popular open source OpenAPI diff tool:

1 changes: 1 error, 0 warning, 0 info
error[request-property-became-required] at payments.json
in API POST /payments
the request property 'cardCvv...
CONTINUE READING
83
Tech Concepts
36
Programming languages
73
Tech Tools
Icon Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.
Icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Icon 50+ new titles added per month and exclusive early access to books as they are being written.
Building an API Product
notes
bookmark Notes and Bookmarks search Search in title playlist Add to playlist download Download options font-size Font size

Change the font size

margin-width Margin width

Change margin width

day-mode Day/Sepia/Night Modes

Change background colour

Close icon Search
Country selected

Close icon Your notes and bookmarks

Confirmation

Modal Close icon
claim successful

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY

Submit Your Feedback

Modal Close icon
Modal Close icon
Modal Close icon