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 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.
Blogger, Nordic APIs
Table of Contents
- 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
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
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
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
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
- 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
- TL/DR - 15 Important Takeaways
- What’s Next?
- Nordic APIs Resources
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 earnedover $12 million USDwriting, 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