API Design on the Scale of Decades
API Design on the Scale of Decades
Learn How to Architect and Design Long-lasting APIs
About the Book
Roy Fielding once described REST as “software design on the scale of decades: every detail is intended to promote software longevity and independent evolution. Many of the constraints are directly opposed to short-term efficiency.” Essentially, Fielding acknowledged that developers often execute short-term design without long-term design in mind, which causes inadaptability as technology evolves.
API Design on the Scale of Decades is a response to this sentiment, digging deep to acknowledge modern web Application Programming Interface architectures and design decisions that will truly stand the test of time. In this volume we provide analysis of API design best practices that make quality developer programs truly stand out, including:
- An introduction and history of Representational State Transfer (REST)
- Assessment of GraphQL as an API query alternative
- Technical case studies in scaling internal API architectures
- Versioning strategies that optimize efficiency
- How to implement agile, serverless API backends
- Learning from API design anti-patterns with microservices
- Securing the future Internet of Things (IoT) with OAuth 2.0 + OpenID Connect
- Deploying API management in an enterprise context
- Benefits of building on Open Standards and the Open API Specification
- and more...
In October 2016 Nordic APIs held it's annual Platform Summit centered on this theme, bringing together over 300 API industry thought leaders to share their insights on what it means to architect and design APIs on the scale of decades. The event detailed design techniques for platform longevity, as well as operational components of sustaining a working API business model.
API Design on the Scale of Decades gathers some of the best information shared by speakers at the 2016 Platform Summit; so even if you weren't able to attend, you can now catch a part of the experience! For this book, we took the 15 most popular speaker sessions on API design technique, and used them as inspiration to craft in-depth chapters on a wide range of API design topics.
All the proceeds from the sale of this book will be donated to the Red Cross in Sweden.
About the Author
About the Contributors
Blogger, Nordic APIs
Art is a copywriter/blogger/content creator who gave up the big city grind to go freelance and live out in the countryside. He writes about everything from financial services and software/technology to health and fitness for big corporations and startups alike. He started his own company, Copywriting Is Art, several years ago and tweets at @ArtCopywriter.
Editor in Chief, Nordic APIs
Bill Doerrfeld is a technologist and writer interested in disruptive software and projecting technology of the future. He is especially devoted to tracking the API economy, and is the Editor in Chief for Nordic APIs, a blog and knowledge base devoted to helping API (Application Programming Interface) providers refine their platforms. Follow him on Twitter, Linkedin, or reach out via email. Visit doerrfeld.io for more.
Table of Contents
-
Preface
- APIs on the Scale of Decades
-
Designing a True REST State Machine
- The History Behind REST and Hypermedia
- How do we Define REST?
- Misconception #3: REST APIs Should be Versioned
- Misconception #4: Hypermedia is Optional for REST APIs
- Example State Machine: IoT Toaster
- Conclusion
-
Is GraphQL The End of REST Style APIs?
- Defining REST and its Limitations
- Round Trip and Repeat Trip Times
- Over/Under Fetching
- Weak Typing and Poor Metadata
- Improper Architecture Usage
- REST Has Many Roundtrips - GraphQL Has Few
- REST Has Poor Type Systems - GraphQL Has a Sophisticated One
- REST Has Poor Discoverability - GraphQL Has Native Support
- REST Is Thin Client/Fat Server - GraphQL is Fat Client/Fat Server
- The End Of The Status Quo
- Conclusion
-
Continuous Versioning Strategy for Internal APIs
- Typical Public API Versioning
- Badoo’s Continuous Versioning Strategies
- Changing the Verification Process
- Updating Banner CTAs for Specific Clients
- Use Flags to Avoid Versioning in Complex Business Logic Changes
- Run Experimental Features
- How Continuous Versioning Could Apply to You
-
Case Study: Spotify Internal Payment APIs
- The Evolution of Spotify Payments
- What’s Really Going on with Online Payments?
- The Checkout API
- The Billing API
- Sample Use Case: Automatic Alerts
- 4 Reasons Why API Design is Critical to Subscription Services
- Analysis: Scalable API-Driven Infrastructure will Power the Future of Online Payments
-
The Benefits of a Serverless API Backend
- What Does “Serverless” Mean?
- From Traditional to Serverless Environments
- How Get Started: Understanding the Serverless Vendors
- Designing Event-Driven Serverless Applications
- 5 Serverless Pro Tips:
- Example: Kickflip SDK
- Building Serverless API Backends
-
Putting an End to API Polling
- What is the Polling Madness?
- One Solution: REST Hooks
- Counter Arguments
- Implementing REST Hooks
- Alternatives
- Conclusion
-
6 Ways to Become a Master Microservice Gardener
- 6 Ways to Become a Master Microservice Gardener
- 1: Use Bimodal IT to Avoid Stagnation
- 2: Avoid the Kafka-esque Monolith
- 3: Design In a Way That Promotes Further Iteration
- 4: Harvest Concepts and Incorporate
- 5: Distribute the Seeds: Adopt True Microservices Arrangement
- 6: Prune the Service Surface
- Nurture API Ecosystem Growth
-
Is Your API Automotive Grade?
- Test It Like it Has to be Automotive Grade
- Automotive Grade and Futureproofing
- Automotive Grade and Backwards Compatibility
- Final Thoughts
-
Why OAuth 2.0 Is Vital to IoT Security
- What is OAuth 2.0?
- What Does OAuth Do?
- Unique IoT Traits that Affect Security
- Proof of Possession
- Disconnected Flow
- Real Worth Authorization Failure
- OAuth Embeds Trust into the IoT
- Conclusion
-
4 Design Tweaks to Improve API Operations
- 1: HTTP GET instead of POST
- 2: Letting clients constantly poll APIs
- 3: Rigid hierarchy in microservices causes latency
- 4: Generic actions
- Harmon-ious Mantras to Live By
-
The API of Me
- Confidential
- Financial
- Tactile
- Aggregate
- Final Thoughts
-
Avoid Walking on Eggshells and Use DevOps
- Silos Are Bad For Business
- Key DevOps Concepts
- DevOps and APIs
- Guides to API Development Management
- Conclusion: Putting Humpty Back Together Again
-
Securing the IoT for Decades to Come
- Looking into the Crystal Ball: The World in 2030
- Identity is the #1 Impediment to Safe IoT Connections
- Building on Open Standards will Secure Future Identity in the IoT
- The Nuances of IoT-Based Communication
- 5 Actionable Steps Toward Improving IoT Security
-
5 Ways the OpenAPI Specification Spurs API Agility
- What is the OpenAPI Specification?
- Why OpenAPI Specification?
- API Fastness
- 1: Proper Design and Approach
- 2: Complete Documentation and Description
- 3: Rapid Testing and Iteration
- 4: Shorter (More Secure) Time to Market
- 5: Machine and Human Readability and Translation
- Conclusion: OpenAPI Enables an Agile API Lifecycle
-
Case Study: Bosch Ongoing Enterprise API Management Saga
- Is building everything yourself always the answer?
- Have an effective strategy
- Be ready for that strategy to fall apart
- Think big, even when you’re small
-
In Summary
- TL/DR - 15 Important Takeaways
- What’s Next?
- Nordic APIs Resources
- Endnotes
Other books by this author
The Leanpub 60-day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
80% Royalties. Earn $16 on a $20 book.
We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.
(Yes, some authors have already earned much more than that on Leanpub.)
In fact, authors have earned$12,307,240writing, publishing and selling on Leanpub.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
OpenIntro Statistics
David Diez, Christopher Barr, Mine Cetinkaya-Rundel, and OpenIntroA complete foundation for Statistics, also serving as a foundation for Data Science.
Leanpub revenue supports OpenIntro (US-based nonprofit) so we can provide free desk copies to teachers interested in using OpenIntro Statistics in the classroom and expand the project to support free textbooks in other subjects.
More resources: openintro.org.
- #2
Personal Finance
Jason AndersonThis textbook provides an in-depth analysis on personal finance that is both practical and straightforward in its approach. It has been written in such a way that the readers can gain knowledge without getting overwhelmed by the technical terms. Suitable for both beginners and advanced learners.
- #3
Getting to Know IntelliJ IDEA
Trisha Gee and Helen ScottIf we treat our IDE as a text editor, we are doing ourselves a disservice. Using a combination of tutorials and a questions-and-answers approach, Getting to Know IntelliJ IDEA will help you find ways to use IntelliJ IDEA that enable you to work comfortably and productively as a professional developer.
- #4
C++20 - The Complete Guide
Nicolai M. JosuttisAll new language and library features of C++20 (for those who know previous C++ versions).
The book presents all new language and library features of C++20. Learn how this impacts day-to-day programming, to benefit in practice, to combine new features, and to avoid all new traps.
Buy early, pay less, free updates.
Other books:
- #5
Mastering STM32 - Second Edition
Carmine NovielloWith more than 1200 microcontrollers, STM32 is probably the most complete ARM Cortex-M platform on the market. This book aims to be the most complete guide around introducing the reader to this exciting MCU portfolio from ST Microelectronics and its official CubeHAL and STM32CubeIDE development environment.
- #6
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
- #7
Machine Learning Q and AI
Sebastian Raschka, PhDHave you recently completed a machine learning or deep learning course and wondered what to learn next? With 30 questions and answers on key concepts in machine learning and AI, this book provides bite-sized bits of knowledge for your journey to becoming a machine learning expert.
- #8
Stats One
William Foote - #9
The Rails 7 Way
Obie Fernandez, Lucas Dohmen, and Tom Henrik AadlandThe Rails™ 7 Way is the comprehensive, authoritative reference guide for professionals delivering production-quality code using modern Ruby on Rails. It illuminates the entire Rails 7 API, its most powerful idioms, design approaches, and libraries. Building on the previous editions, this edition has been heavily refactored and updated.
- #10
Gradual Modularization for Ruby and Rails
Stephan HagemannGet yourself a new tool to manage your Rails application and your growing engineering organization! Prevent the ball-of-mud (and fix it!). Go for microservices or SOA if it makes sense not just because you don't have any other tool. Do all this through a low-overhead tool: packages. Enable better conversations to make practical changes today.
Top Bundles
- #1
Software Architecture
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #2
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #3
1500 QUIZ COMMENTATI (3 libri)
3 Books
Tre libri dei QUIZ MMG Commentati al prezzo di DUE! I QUIZ dei concorsi ufficiali di Medicina Generale relativi agli anni: 2000-2001-2003-2012-2013-2014-2015-2016-2017-2018-2019-2020-2021 +100 inediti Raccolti in unico bundle per aiutarvi nello studio e nella preparazione al concorso. All'interno di ogni libro i quiz sono stati suddivisi per... - #4
Pattern-Oriented Memory Forensics and Malware Detection
2 Books
This training bundle for security engineers and researchers, malware and memory forensics analysts includes two accelerated training courses for Windows memory dump analysis using WinDbg. It is also useful for technical support and escalation engineers who analyze memory dumps from complex software environments and need to check for possible... - #5
Practical FP in Scala + Functional event-driven architecture
2 Books
Practical FP in Scala (A hands-on approach) & Functional event-driven architecture, aka FEDA, (Powered by Scala 3), together as a bundle! The content of PFP in Scala is a requirement to understand FEDA so why not take advantage of this bundle!? - #6
Modern C++ Collection
3 Books
Get All about Modern C++C++ Standard Library, including C++20Concurrency with Modern C++, including C++20C++20Each book has about 200 complete code examples. Updates are included. When I update one of the books, you immediately get the updated bundle. You can expect significant updates to each new C++ standard (C++23, C++26, .. ) and also... - #7
Linux Administration Complet
4 Books
Ce lot comprend les quatre volumes du Guide Linux Administration :Linux Administration, Volume 1, Administration fondamentale : Guide pratique de préparation aux examens de certification LPIC 1, Linux Essentials, RHCSA et LFCS. Administration fondamentale. Introduction à Linux. Le Shell. Traitement du texte. Arborescence de fichiers. Sécurité... - #9
Development and Deployment of Multiplayer Online Games, Part ARCH. Architecture (Vol. I-III)
3 Books
What's the Big Idea? The idea behind this book is to summarize the body of knowledge that already exists on multiplayer games but is not available in one single place.And quite a fewof the issues discussed within this series (planned as three nine volumes ~300 pages each), while known in the industry, have not been published at all (except for... - #10
Growing Agile: The Complete Coach's Guide
7 Books
Growing Agile: Coach's Guide Series This bundle provides a collection of training and workshop plans for a variety of agile topics. The series is aimed at agile coaches, trainers and ScrumMasters who often find themselves needing to help teams understand agile concepts. Each book in the series provides the plans, slides, handouts and activity...
