Skip to Content
Design and Build Great Web APIs
book

Design and Build Great Web APIs

by Mike Amundsen
October 2020
Intermediate to advanced
358 pages
8h 39m
English
Pragmatic Bookshelf
Content preview from Design and Build Great Web APIs

Identifying Your API Descriptors

The first step in our API design method deals with identifying the names we’ll use for all our data elements and actions. I call these bits of information descriptors since they’re meant to describe the contents of the data elements (for example, companyName) and describe the action a developer would be taking (for example, approveUser). While the actual name we use for this isn’t too important, what is important is that we’ll be using the same name (descriptor) for both data and action identifiers. Often we spend a great deal of time covering the names of data elements but don’t always spend as much time on the names of the actions.

Another important aspect of focusing on the descriptors in our API design ...

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

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’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.
Head of Cybersecurity
QuotationMarkI 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.
Field Engineer
QuotationMarkI’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.
Data Platform Tech Lead
QuotationMarkI'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.
Mark W.
Embedded Software Engineer

You might also like

The Design of Web APIs

The Design of Web APIs

Arnaud Lauret
System Design Masterclass

System Design Masterclass

Rohit Jain Sweet Codey, Suresh Gandhi, Shubham Chandak

Publisher Resources

ISBN: 9781680508123Errata Page