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,690,775writing, 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
Ansible for Kubernetes
Jeff GeerlingAnsible is a powerful infrastructure automation tool. Kubernetes is a powerful application deployment platform. Learn how to use these tools to automate massively-scalable, highly-available infrastructure.
- #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 Design and Architecture
Alexander GraninSoftware Design in Functional Programming, Design Patterns and Practices, Methodologies and Application Architectures. How to build real software in Haskell with less efforts and low risks. The first complete source of knowledge.
- #4
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.
- #5
Tame your Work Flow
Steve Tendon and Daniel DoironDo you need a high performance enterprise governance approach improving management, execution and delivery while dealing with multiple projects/products, events, stakeholders and teams? Giving you better bottom line results, faster time to market, less work, better predictability, happier employees, and delighted clients? Then learn about TameFlow!
- #6
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.
- #7
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
- #8
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
- #9
Composing Software
Eric ElliottAll software design is composition: the act of breaking complex problems down into smaller problems and composing those solutions. Most developers have a limited understanding of compositional techniques. It's time for that to change.
- #10
El Manual del Manager
Keyvan Akbary, Félix López, and Álvaro Salazar¿Has deseado alguna vez el haber tenido una buena introducción al rol del Engineering Manager? En este libro aprenderás lo necesario para ejercer el rol de una manera efectiva: Expectativas y Responsabilidades del Rol, 1-1s, Ayudar a Crecer, Objetivos, Planes de Carrera, Cultura, Feedback, Contratación, Cultura de Producto y mucho más.
Top Bundles
- #1
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... - #2
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. - #3
WTFlop 6M + HU - Beta Bundle
6 Books
- #4
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... - #5
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... - #6
General Systems Thinker Bundle
5 Books
The General Systems Thinker Bundle is just that: a bundle of five books to advance the reader one giant step toward improved thinking, based on General Systems principles. Four of the books are the complete General Systems Series. The fifth is fictional piece which shows some general systems thinkers in action. It's a mystery in which a group of... - #7
Experiential Learning Bundle
4 Books
This bundle provides all four volumes of the popular Experiential Learning Series at a savings of $20 over the price if purchased separately. - #8
Ansible Bundle
2 Books
After getting up and running with Ansible in Jeff Geerling's Ansible for DevOps, strengthen your skills managing tens to thousands of instances and services in Amazon's AWS cloud with Yan Kurniawan's Ansible for AWS. - #9
Learn ECMAScript 6 inside and out
2 Books
For any technology, it helps to get multiple points of view on the functionality to get the best possible understanding. For ECMAScript 6/2015, no two resources are recommended more frequently thanExploring ES6by Dr. Axel Rauschmayer andUnderstanding ECMAScript 6by Nicholas C. Zakas. These two points of view, investigating the specification and... - #10
Software architecture, for systems old and new
2 Books
This bundle includes books about hands-on software architecture.
