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 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Do Well. Do Good.
Authors have earned$10,906,214writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
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), EPUB (for phones and tablets) and MOBI (for 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
Practical FP in Scala: A hands-on approach
Gabriel VolpeA practical book aimed for those familiar with functional programming in Scala who are yet not confident about architecting an application from scratch.
Together, we will develop a purely functional application using the best libraries in the Cats ecosystem, while learning about design patterns and best practices.
- #2
入門 日本語自然言語処理
Masato Hagiwara and Paul O'Leary McCann日本語テキストを処理したい全てのプログラマ・エンジニアの方へ。分かち書きなどの基本から、自然言語生成などの最新の話題までをカバー。動かして学べるコードや、参照文献も付いています。言語学や機械学習の知識が無くても問題ありません。
- #3
Learning Algorithms Through Programming and Puzzle Solving
Alexander S. Kulikov and Pavel PevznerThis book powers our MicroMasters program on edX and specialization on Coursera, one of the ten most popular computer science courses on Coursera. Over half a million students have tried to solve many programming challenges and algorithmic puzzles described in this book. We invite you to join them! See the webpage of the book for more details.
- #4
Functional Programming Made Easier
Charles ScalfaniA Functional Programming book from beginner to advanced without skipping a single step along the way.
In my 40 years of programming, I've felt that programming books always let me down, especially Functional Programming books. So, I wrote the book I wish I had 5 years ago.
Functional Programming will never be easy, but it can be easier.
- #5
Functional event-driven architecture: Powered by Scala 3
Gabriel VolpeExplore the event-driven architecture (EDA) in a purely functional way, mainly powered by Fs2 streams in Scala 3!
Leverage your functional programming skills by designing and writing stateless microservices that scale, powered by stateful message brokers.
- #6
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #7
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.
- #8
Cloud Strategy
Gregor Hohpe“Strategy is the difference between making a wish and making it come true.” A successful migration to the cloud can transform your organization, but it shouldn’t be driven by wishes. This book tells you how to develop a sound strategy guided by frameworks and decision models without being overly abstract nor getting lost in product details.
- #9
Visualise, document and explore your software architecture
Simon BrownA short guide to visualising, documenting and exploring your software architecture.
- #10
Scrum Product Ownership - Navigating the Forest AND the Trees, 3'rd Edition
Robert GalenIn 2009, I published Scrum Product Ownership - Ed. 1. Then the 2'nd Ed. in 2013. This is the 3'rd edition, celebrating the 10th anniversary of the original book. It's evolved from a beginners guide to be a more balanced reference for beginners, practitioner, and expert Product Owners.
Top Bundles
- #1
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
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
The Indie Python Extravaganza
5 Books
The Indie Python Extravaganza! A collection of books that will help you to improve your knowledge of the Python programming language one page at a time. Join four indie authors in a journey from the basics of Python to the structure of production-ready systems, going through the core features of the language, some intermediate projects and a... - #3
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... - #4
All the Books of The Medical Futurist
6 Books
We put together the most popular books from The Medical Futurist to provide a clear picture about the major trends shaping the future of medicine and healthcare. Digital health technologies, artificial intelligence, the future of 20 medical specialties, big pharma, data privacy, digital health investments and how technology giants such as Amazon... - #7
Abandon Your Job - Leaving the Rat Race with Python
8 Books
Now, get all the great Python and Freelancing books from finxter.com in one single bundle!Coffee Break Python - All Python BasicsCoffee Break Python Workbook - Practice the basics of PythonCoffee Break Python Mastery Workouts - Practice advanced Python conceptsCoffee Break Python Slicing - All about SlicingCoffee Break Python NumPy - Get started... - #8
10 Books Bundle - A New Career in Tech 🚀
10 Books
Do you want to create yourself a new and profitable skillset - in one year or less? Do you want to position yourself on the right side of change finally? Do you want to work from home and set your own work schedule while choosing fun and interesting coding projects? Software developers and freelance developersearn six figuresin the US, according... - #9
The Python Craftsman
3 Books
The Python Craftsman series comprises The Python Apprentice, The Python Journeyman, and The Python Master. The first book is primarily suitable for for programmers with some experience of programming in another language. If you don't have any experience with programming this book may be a bit daunting. You'll be learning not just a programming...
