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

Shutting Down an Existing API

As you create more and more APIs and deploy updates for the ones you have in production, eventually you’ll run into the need to shut down one or more of them. The process of “turning off” your API means addressing several important issues in order to ensure data integrity and operational safety, including these:

  • Communicating the API shutdown
  • Placing code in the public domain
  • Publishing the interface design as open source
  • Making consumer data recoverable
  • Marking your API 410 GONE

Let’s briefly look at each one of these issues.

Communicating the API Shutdown

Before you shut things down, you need to make sure you’ve notified all the API consumers you can. For internal APIs, this is often done through company-wide email ...

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

Designing Web APIs

Designing Web APIs

Brenda Jin, Saurabh Sahni, Amir Shevat
API Design Patterns

API Design Patterns

John J. Geewax
Node.js Design Patterns - Third Edition

Node.js Design Patterns - Third Edition

Mario Casciaro, Luciano Mammino

Publisher Resources

ISBN: 9781680508123Errata Page