Build APIs You Won't Hate
Build APIs You Won't Hate
Everyone and their dog wants an API, so you should probably learn how to build them.
About the Book
API development is becoming increasingly common for server-side developers thanks to the rise of front-end JavaScript frameworks, iPhone applications, and API-centric architectures. It might seem like grabbing stuff from a data source and shoving it out as JSON would be easy, but surviving changes in business logic, database schema updates, new features, or deprecated endpoints can be a nightmare.
After finding many of the existing resources for API development to be lacking, Phil learned a lot of things the hard way through years of trial and error. This book aims to condense that experience, taking examples and explanations further than the trivial apples and pears nonsense tutorials often provide.
Phil worked primarily as an API developer for the last three years. One horror was managing an API built in FuelPHP by a freelancer at the million dollar startup he joined. It was utilizing a then deprecated ORM which had been hacked to death by the previous developer, so took the time to delete that mess and build the next version in Laravel, leveraging it's simple routing, database migrations, schema, seeding, etc. When the following major version of the API was built no rewrite was required, and both managed to live side-by-side on the same "API" servers.
By passing on some best practices and general good advice you can hit the ground running with API development, combined with some horror stories and how they were overcome/avoided/averted. This book will discuss the theory of designing and building APIs in any language or framework, with this theory applied in PHP-based examples.
Some of the more advanced topics covered here are endpoint testing, embedding data objects in a consistent and scalable manner, paginating responses (including embedded objects) and hypermedia "HATEOAS" controls.
About the Author
Bundles that include this book
About the Contributors
Technical Review
Editor
Cameo Coder
Table of Contents
- Introduction
- Sample Code
-
1. Useful Database Seeding
- 1.1 Introduction
- 1.2 Introduction to Database Seeding
- 1.3 Building Seeders
- 1.4 That is about it
- 1.5 Secondary Data
- 1.6 When to run this?
-
2. Planning and Creating Endpoints
- 2.1 Functional Requirements
- 2.2 Endpoint Theory
- 2.3 Planning Endpoints
-
3. Input and Output Theory
- 3.1 Introduction
- 3.2 Requests
- 3.3 Responses
- 3.4 Supporting Formats
- 3.5 Content Structure
-
4. Status Codes, Errors and Messages
- 4.1 Introduction
- 4.2 HTTP Status Codes
- 4.3 Error Codes and Error Messages
- 4.4 Error or Errors
- 4.5 Standards for Error Responses
- 4.6 Common Pitfalls
-
5. Endpoint Testing
- 5.1 Introduction
- 5.2 Concepts & Tools
- 5.3 Setup
- 5.4 Initialise
- 5.5 Features
- 5.6 Scenarios
- 5.7 Prepping Behat
- 5.8 Running Behat
-
6. Outputting Data
- 6.1 Introduction
- 6.2 The Direct Approach
- 6.3 Transformations with Fractal
- 6.4 Hiding Schema Updates
- 6.5 Outputting Errors
- 6.6 Testing this Output
- 6.7 Homework
-
7. Data Relationships
- 7.1 Introduction
- 7.2 Subresources
- 7.3 Foreign Key Arrays
- 7.4 Compound Documents (aka Sideloading)
- 7.5 Embedded Documents (aka Nesting)
- 7.6 Summary
-
8. Debugging
- 8.1 Introduction
- 8.2 Command-line Debugging
- 8.3 Browser Debugging
- 8.4 Network Debugging
-
9. Authentication
- 9.1 Introduction
- 9.2 When is Authentication Useful?
- 9.3 Different Approaches to Authentication
- 9.4 Implementing an OAuth 2.0 Server
- 9.5 Where the OAuth 2.0 Server Lives
- 9.6 Understanding OAuth 2.0 Grant Types
-
10. Pagination
- 10.1 Introduction
- 10.2 Paginators
- 10.3 Offsets and Cursors
-
11. Documentation
- 11.1 Introduction
- 11.2 Types of Documentation
- 11.3 Picking a Tool
- 11.4 Setting up API Blueprint and Aglio
- 11.5 Learning API Blueprint Syntax
- 11.6 Further Reading
-
12. HATEOAS
- 12.1 Introduction
- 12.2 Content Negotiation
- 12.3 Hypermedia Controls
-
13. API Versioning
- 13.1 Introduction
- 13.2 Different Approaches to API Versioning
- 13.3 Ask Your Users
-
14. Bonus Chapter: File Uploads & Downloads
- 14.1 Introduction
- 14.2 Downloads
- 14.3 Uploads
- 14.4 Why Multipart is Fairly Awful
- 14.5 Method A: Direct File Upload
- 14.6 Method B: Upload from URL
- 14.7 What about Meta Data?
- 14.8 Summary
- Conclusion
-
Further Reading
- API Web Resources
- Non-API Books
Causes Supported
Code Club
https://www.codeclub.org.ukA nationwide network of volunteer-led after school coding clubs for children aged 9-11.
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,607,028writing, 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
Jetpack Compose internals
Jorge CastilloJetpack Compose is the future of Android UI. Master how it works internally and become a more efficient developer with it. You'll also find it valuable if you are not an Android dev. This book provides all the details to understand how the Compose compiler & runtime work, and how to create a client library using them.
- #2
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.
- #3
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.
- #4
Discrete Mathematics for Computer Science
Alexander Shen, Alexander S. Kulikov, Vladimir Podolskii, and Alexander GolovnevThis book supplements the DM for CS Specialization at Coursera and contains many interactive puzzles, autograded quizzes, and code snippets. They are intended to help you to discover important ideas in discrete mathematics on your own. By purchasing the book, you will get all updates of the book free of charge when they are released.
- #5
C++20 - The Complete Guide
Nicolai M. JosuttisAll the new language and library features of C++20 (for those who know previous 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:
- #6
Thinking with Types
Sandy MaguireThis book aims to be the comprehensive manual for type-level programming. It's about getting you from here to there---from a competent Haskell programmer to one who convinces the compiler to do their work for them.
- #7
Algebra-Driven Design
Sandy MaguireA how-to field guide on building leak-free abstractions and algebraically designing real-world applications.
- #8
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.
- #9
Stratospheric
Tom Hombergs, Björn Wilmsmann, and Philip RiecksFrom Zero to Production with Spring Boot and AWS. All you need to know to get a Spring Boot application into production with AWS. No previous AWS knowledge required.
- #10
The Technological Future of Medical Specialties - 2021 Edition
Dr. Bertalan MeskoHow will the appearance of AI, sensors, wearables, VR/AR or robots affect each medical specialty? How can physicians of the various professions successfully prepare for the sweeping changes coming with the waves of technology? Read the eBook to find out
45-day Money-back guarantee: If you're not satisfied, simply return the book & get a full refund
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
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
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... - #5
Retromat eBook Bundle for Agile Retrospectives
2 Books
If you facilitate retrospectives this bundle is for you: "Plans for Retrospectives" helps beginners learn the lay of the land with tried-and-true plans. Once you know your way around, "Run great agile retrospectives" contains all 135+ activities in Retromat for you to mix and match. - #6
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... - #8
9 Books-Bundle: Shut Up and Code!
9 Books
"Shut up and code." Laughter in the audience. The hacker had just plugged in his notebook and started sharing his screen to present his super-smart Python script. "Shut up and code" The letters written in a white literal coding font on black background was the hackers' home screen background mantra. At the time, I was a first-year computer...
