July 2023
Intermediate to advanced
50 pages
1h 5m
English
Content preview from What Are Asynchronous APIs?
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Chapter 2. Designing APIs with AsyncAPI
In this chapter, we’ll get hands-on with the work of designing an asynchronous API for the ordering system of a shoe store. We’ll introduce and use the AsyncAPI description language to define the specification of our API. By the end of the chapter, we’ll have designed a complete asynchronous API. Let’s get started by taking a closer look at the AsyncAPI format.
Why AsyncAPI?
APIs enable software to perform jobs and access data by providing an interface. Well-designed APIs make it easier for developers to write code that uses that interface. Good API design includes using words that developers understand and describing functions that fit the developer’s jobs to be done. But, along with these design concerns, designers need a way to clearly describe what their API does in a meaningful, easy-to-consume manner. That’s where API description languages help.
Description languages are standardized formats for describing the important parts of an API. For many years, the Open API Specification (OAS) has been the universal description language for HTTP and RESTful APIs. Thanks to OAS, an API designer can express their design choices for URIs, HTTP methods, and message schemas in a single, standardized file. That OAS API description can then be automatically imported and used in a rich ecosystem of tools for discovery, documentation, development, testing, and release.
But, OAS isn’t a great fit for the EVENTful style of APIs we described in the previous ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.