A Practical Approach to API Design
A Practical Approach to API Design
From Principles to Practice
About the Book
If you read the tech press, everyone knows they need an API but most aren't really sure what it is. They treat it as another checkbox like "Web 2.0" was a few years ago or a mobile app was most recently. In fact, there's an entire "API-first" movement in development circles that most people don't understand or even realize why. In this book, we'll start by discussing the what an API is, why you might need one, and follow up with the how to build one.
With addition of our Appendix on API Design Patterns and numerous other design tips, this book is complete. Regardless, we're always open to additional sections, concepts, and questions so don't hesitate to drop us a note. Further, when you find something interesting, let us know. If you think we’re wrong, say so. If you think we’re right, tell your friends. If you want us to teach your team more and deeper concepts, please let us know.
About the Authors
Packages
The Book
English
PDF
EPUB
MOBI
WEB
Team Package
This is a 5-book team package of A Practical Approach to API Design.
English
PDF
EPUB
MOBI
WEB
Bundles that include this book
Table of Contents
- Welcome
- Changelog
-
Chapter 1 - APIs: An Introduction
- What is an API
- Why you should have an API
-
Chapter 2 - Principles of Pragmatic API Design
- API or SOA?
- API and SOA: Extend and Accelerate
- REST vs. SOAP
- APIs for Existing Applications
-
Chapter 3 - Beyond CRUD
- Building APIs for Business Workflows
- Affordances
- Why you should trust others’ APIs
-
Chapter 4 - The API Modeling Process
- Summary of the Steps
- Step 1: Identify the Participants
- Step 2: Identify the Activities
- Step 3: Break Each Activity Into Steps
- Step 4: Create and Group API Methods
- Step 5: Validate the API By Testing
- Common Questions About API Modeling
- Next Step: Design
-
Chapter 5 - The Principles of HTTP and REST
- HTTP Core Concepts
- Web APIs and the Richardson Maturity Model
- Back to Basics: The 6 REST Constraints
- The Next Steps
-
Chapter 6 - From Modeling to RESTful Design
- Building Your Resource Taxonomy
- Defining Resource Lifecycles
- Mapping Response Codes For Success and Failure
- Expanding Resources Through Hypermedia Linking
- Common Questions About API Design
- Next steps
-
Chapter 7 - Message Formats
- Hypermedia Specifications
- Selecting a Data Storage Strategy
-
Chapter 8 - Documenting Your API
- The Hidden Value of API Documentation
- API Definition Formats
- Beyond API Reference Documentation
-
Chapter 9 - Prototyping Your API
- Static Prototyping
- Building a Working Prototype
-
Chapter 10 - API Product Management
- The API-First Organization
- Front-End, Back-End, and Full Stack Developers
- Partitioning API Teams
- Accelerating API Integration
-
Chapter 11 - Authentication & Authorization
- Authentication
- Authorization
-
Appendix A - API Design Patterns
- Adjectives
- API Security
- Bulk and Batch
- Caching
- Deleting Resources
- Error Handling
- Extended Resource Lifecycle
- Functional Endpoints
- Idempotency
- Pagination
- Sitemap
- Singleton Resources
- Transactional Resources
- Versioning
- Zoom/Embed
-
Appendix B - Additional Resources
- Books
- News & Information
- White Papers & Industry Reports
Authors have earned$9,539,843writing, 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
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
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
Algebra-Driven Design
Sandy MaguireA how-to field guide on building leak-free abstractions and algebraically designing real-world applications.
- #2
Production Haskell
Matt ParsonsAre you excited about Haskell, but don't know where to begin? Are you thrilled by the technical advantages, but worried about the unknown pitfalls? This book has you covered.
- #3
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.
- #4
The Hundred-Page Machine Learning Book
Andriy BurkovEverything you really need to know in Machine Learning in a hundred pages.
- #5
Machine Learning Engineering
Andriy Burkov"If you intend to use machine learning to solve business problems at scale, I'm delighted you got your hands on this book."
—Cassie Kozyrkov, Chief Decision Scientist at Google
"Foundational work about the reality of building machine learning models in production."
—Karolis Urbonas, Head of Machine Learning and Science at Amazon
- #6
Cloud Strategy
Gregor HohpeWhile most enterprises are moving to the cloud these days, many initiatives are driven by wishes or promises rather than a sound strategy. Harvested from half a decade of cloud migrations, this book shares frameworks, strategies, and anecdotes for a structured and decision-centric path to cloud success.
- #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
CCIE Service Provider Version 4 Written and Lab Exam Comprehensive Guide
Nicholas RussoThe service provider landscape has changed rapidly over the past several years. Networking vendors are continuing to propose new standards, techniques, and procedures for overcoming new challenges while concurrently reducing costs and delivering new services. Cisco has recently updated the CCIE Service Provider track to reflect these changes; this book represents the author's personal journey in achieving that certification.
- #9
CCIE SP v4.1 - Workbook
Łukasz Bromirski, Piotr Jablonski, and Nicholas RussoAre you striving to prepare to and pass CCIE SP lab exam? Take the opportunity and get this workbook! With the attached initial cfg files you will prepare yourself for the CCIE SP exam as well as learn SP technologies applicable to all kinds of today modern networks! This workbook covers blueprint topics and provides challenging examples.
- #10
Sockets and Pipes
Type ClassesSockets and Pipes is not an introduction to Haskell; it is an introduction to writing software in Haskell. Using a handful of everyday Haskell libraries, this book walks through reading the HTTP specification and implementing it to create a web server.
Top Bundles
- #1
The Node.js Bundle
3 Books
This bundle combines three bestselling Leanpub Node.js books into a package that gives you everything you need to get started with developing Node.js applications at an unbeatable price. - #2
The Tester's Library
8 Books
The Tester's Library consists of eight five-star books that every software tester should read and re-read. As bound books, this collection would cost over $200. Even as e-books, their price would exceed $80, but in this bundle, their cost is only $49.99. Here are the books, and why they should be in your library: Perfect Software and Other... - #3
agile
11 Books
In this bundle, you will find 10 different agile books. They are about different aspects of being agile. - finding a job - doing coding dojo's - Retrospectives - Personal kanban - a non-typical coaching book and even a book that gives you an insight in the lives of some agile people. - #4
WTFlop 6M + HU - Beta Bundle
6 Books
- #5
Node Patterns
6 Books
- #6
Fifty Quick Ideas
3 Books
Get all three books for the price of two! Fifty Quick Ideas books are full of practical, real-world techniques that you can use to improve teamwork, build better products and build them in a better way. - #7
Growing Agile: Coach's Guide Series
4 Books
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 instructions to run a number of... - #8
Marionette.js A to Z
3 Books
Marionette.js has become a popular Backbone-based javascript library, because it helps you avoid boiler-plate code and focus on what makes your app special. But how do you get started?Whether you want to finally get started with dynamic client-side programming (like one reader did), or are an experienced front-end dev who has inherited a... - #9
Complete Scala Bundle
3 Books
Scala is a general-purpose programming language and it's getting extremely popular these days. Some say that learning Scala could be a challenging task. My experience, however, suggests that this is actually a myth that has very little to do with reality. With the right approach, learning Scala can be easy, fun and rewarding.The first book from... - #10
Build A Better Backbone App
3 Books
The best way to learn new development skills is through experience, but that takes time you don't have.Get the best of both worlds with this bundle: you'll learn how to produce modern web applications by learning from experienced developers like Derick Bailey and David Sulc. BackboneJS is one of the favorite tools on the web today, but it...
