Writing APIs with Lumen
Writing APIs with Lumen
A Hands-on Guide to Writing API Services With PHP
About the Book
Learn to Write REST APIs from Scratch
Want to learn how to write fully-tested REST APIs and microservices with PHP? I will walk you through developing an API and teach you how to test your code along the way.
In this book you will learn how to use Lumen—a micro-framework by Laravel—to write bullet-proof APIs. Lumen helps you write productive, maintainable APIs using modern application design.
This book is suitable for PHP developers with no Laravel experience. Only a basic understanding of HTTP and writing PHP applications is needed to get started.
What's Inside the Book?
You will learn how to write fully-tested APIs and understand essential Lumen concepts used to build a solid foundation for writing API projects. You will also learn:
- To Maintain your API's database structure through built-in database migrations
- Writing Tests with factory data in a test database
- Responding with Consistent data output in JSON
- How to respond to PHP Exceptions with JSON Responses
- How to Create, Read, Update, and Delete REST Resources
- How to represent model associations in API responses
- A solid foundation for writing tests with PHPUnit and Mockery
- Data Validation
This book is not only teaching you Lumen, it will walk you through how to use TDD to write applications and mock objects. This book is basically two books in one, in an easy-to-follow tutorial format.
About the Author
Reader Testimonials
Daniel Baron
Freelance Web Developer
If you need a head-start on how to use Lumen for stateless APIs, you should get this book. It shows the concepts on how to design, develop and test an API from the very beginning.
Michael Dyrynda
Developer, Hostworks
Paul’s “Writing APIs with Lumen” is an excellent resource for anybody looking to build APIs with the Lumen Framework. It is a thorough introduction not only to Lumen, but to writing code through test driven development using the tools available to the framework.
Table of Contents
-
Introduction
- The Same Tools to Write APIs and Web Applications
- Who This Book is For
- Conventions Used in This Book
- Tools You Will Need
- About Me
-
Chapter 1: Installing Lumen
- Homestead
- Mac OSX
- Linux
- Windows
- Conclusion
-
Chapter 2: Hello Lumen
- 2.1: Setting Up a New Project
- 2.2: Routes
- 2.3: Middleware and Responses
- 2.4: Views
- Onward
-
Chapter 3: Creating the Book Application
- Build Something Amazing
- Environment Setup
- Checking Unit Tests
- Setup Complete
-
Chapter 4: Starting the Books API
- Creating the First Endpoint
- Setting up Models and Seed Data
- Eloquent Books
- Success
-
Chapter 5: Creating, Reading, Updating, and Deleting Books
- 5.1: Requesting an Individual Book
- 5.2: Creating a New Book
- 5.3: Updating an Existing Book
- 5.4: Deleting books
- Conclusion
-
Chapter 6: Responding to Errors
- 6.1: Test Database
- 6.2: Better Error Responses
- 6.3: Testing the Exception Handler
- Conclusion
-
Chapter 7: Leveling Up Responses
- 7.1: Introducing Fractal
- 7.2: First Version of API Response Formatting
- 7.2: The FractalResponse Class
- 7.3: FractalResponse Service
- 7.4: Integrating the FractalResponse Service
- Conclusion
-
Chapter 8: Validation
- 8.1: First Attempt at Validation
- 8.2: More Validation Constraints
- 8.3: Custom Validation Messages
- Conclusion
-
Chapter 9: Authors
- 9.1: The Authors database schema
- 9.2: Fixing Broken Tests
- Conclusion
-
Chapter 10: The /authors API Resource
- 10.1: The GET /authors Endpoint
- 10.2: The GET /authors/{id} Endpoint
- 10.3: The POST /authors Endpoint
- 10.4: The PUT /authors/{id} Endpoint
- 10.5: The DELETE /authors/{id} Endpoint
- Conclusion
-
Chapter 11: Book Bundles
- 11.1: Defining the Relationship Between Books and Bundles
- 11.2: The GET /bundles/{id} Endpoint
- 11.3: Adding a Book to a Bundle
- 11.4: Remove a Book from a Bundle
- Conclusion
-
Chapter 12: Ratings
- 12.1: Database Design
- 12.2: Rating an Author
- 12.3: Ratings in the Author API
- 12.4: Eager Loading Ratings
- Conclusion
-
Where To Go From Here
- Laravel
- Laracasts
- Mockery
- Guzzle
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
Do Well. Do Good.
Authors have earned$11,845,077writing, 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) 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
The Hitchhiker's Guide to DFIR: Experiences From Beginners and Experts
Barry Grundy, Tristram, John Haynes, ApexPredator, Andrew Rathbun, Kevin Pagano, Victor Heiland, Nisarg Suthar, Guus Beckers, and Jason WilkinsA first-of-its-kind crowdsourced Digital Forensics and Incident Response (DFIR) book by the Digital Forensics Discord Server members to share knowledge!
- #2
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.
- #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
Maîtriser Apache JMeter
Philippe Mouawad, Bruno Demion (Milamber), and Antonio Gomes RodriguesToute la puissance d'Apache JMeter expliquée par ses commiteurs et utilisateurs experts. De l'intégration continue en passant par le Cloud, vous découvrirez comment intégrer JMeter à vos processus "Agile" et Devops.
If you're looking for the newer english version of this book, go to Master JMeter : From load testing to DevOps
- #5
Software Architecture for Developers
Simon BrownA developer-friendly, practical and pragmatic guide to lightweight software architecture, technical leadership and the balance with agility.
- #6
Functional Event-Driven Architecture
Gabriel VolpeExplore the event-driven architecture (EDA) in a purely functional way. Learn to design and develop distributed systems that scale. Identify common design patterns in such systems.
Take your functional programming skills to the next level by joining me in developing a distributed system powered by Apache Pulsar and Fs2 streams, all in Scala 3!
- #7
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.
- #8
Concurrency with Modern C++
Rainer GrimmC++11 is the first C++ standard that deals with concurrency. The story goes on with C++17, C++20, and will continue with C++23.
I'll give you a detailed insight into the current and the upcoming concurrency in C++. This insight includes the theory and a lot of practice.
- #9
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.
- #10
Biological Modeling
Phillip CompeauIn this ebook, learn why zebras have stripes, why SARS-CoV-2 spread so quickly around the planet, how to train a computer to classify cellular images, and more!
Top Bundles
- #1
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... - #2
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... - #3
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... - #4
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
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... - #8
Learn Git, Bash, and Terraform the Hard Way
3 Books
Learn Git, Bash and Terraform using the Hard Way method.These technologies are essential tools in the DevOps armoury. These books walk you through their features and subtleties in a simple, gradual way that reinforces learning rather than baffling you with theory. - #9
Quality Software
11 Books
The Quality Software Bundle is for managers, would-be managers, and any of us who find themselves being managed and confused. This comprehensive bundle covers the entire span of software development approaches, from hacking through waterfall, cascade, prototyping, Iterative enhancement, reusable code, off-the-shelf, to Agile teams. The bundle... - #10
Static Analysis and Automated Refactoring
2 Books
As PHP developers we are living in the "Age of Static Analysis". We can use a tool like PHPStan to learn about potential bugs before we ship our code to production, and we can enforce our team's programming standards using custom PHPStan rules. Recipes for Decoupling by Matthias Noback teaches you in great detail how to do this, while also...
