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
Authors have earned$9,909,464writing, 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
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
- #2
Continuous Delivery Pipelines
Dave FarleyThis practical handbook provides a step-by-step guide for you to get the best continuous delivery pipeline for your software.
- #3
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.
- #4
C++20
Rainer GrimmC++20 is the next big C++ standard after C++11. As C++11 did it, C++20 changes the way we program modern C++. This change is, in particular, due to the big four of C++20: ranges, coroutines, concepts, and modules.
The book is almost daily updated. These incremental updates ease my interaction with the proofreaders.
- #5
Atomic Kotlin
Bruce Eckel and Svetlana IsakovaFor both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java together with a member of the Kotlin language team comes a book that breaks the concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA!
- #6
Introductory Statistics with Randomization and Simulation
Mine Cetinkaya-Rundel, Christopher Barr, OpenIntro, and David DiezA complete foundation for Statistics, also serving as a foundation for Data Science, that introduces inference using randomization and simulation while covering traditional methods.
Leanpub revenue supports OpenIntro, so we can provide free desk copies to teachers interested in using our books in the classroom.
More resources: openintro.org.
- #7
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.
- #8
Java OOP Done Right
Alan MellorObject Oriented Programming is still a great way to create clean, maintainable code. But only if you use it right.
This book gives you 25 years of OO best practice, ready to use.
You'll learn to design objects behaviour-first, use TDD to help, then confidently apply Design Patterns, SOLID principles and Refactoring to make clean, crafted code.
- #9
Introducing EventStorming
Alberto BrandoliniThe deepest tutorial and explanation about EventStorming, straight from the inventor.
- #10
Discrete Mathematics for Computer Science
Alexander Shen, Alexander S. Kulikov, Vladimir Podolskii, and Aleksandr 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.
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
Cisco CCNA 200-301 Complet
4 Books
Ce lot comprend les quatre volumes du guide préparation à l'examen de certification Cisco CCNA 200-301. - #4
Modern C++ by Nicolai Josuttis
2 Books
- #5
CCDE Practical Studies (All labs)
3 Books
CCDE lab - #6
"The C++ Standard Library" and "Concurrency with Modern C++"
2 Books
Get my books "The C++ Standard Library" and "Concurrency with Modern C++" in a bundle. The first book gives you the details you should know about the C++ standard library; the second one dives deeper into concurrency with modern C++. In sum, you get more than 600 pages full of modern C++ and about 250 source files presenting the standard library... - #7
Mastering Containers
2 Books
Docker and Kubernetes are taking the world by storm! These books will get you up-to-speed fast! Docker Deep Dive is over 400 pages long, and covers all objectives on the Docker Certified Associate exam.The Kubernetes Book includes everything you need to get up and running with Kubernetes! - #8
Modern Management Made Easy
3 Books
Read all three Modern Management Made Easy books. Learn to manage yourself, lead and serve others, and lead the organization. - #9
The Future of Digital Health
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 and how technology giants such as Amazon or Google want to conquer... - #10
Django for Beginners/APIs/Professionals
3 Books
