How to add a new resource like a blog post in this Lumen boilerplate?

Follow the README's detailed steps: create routes with scope middleware, model and migration, repository with service provider binding, Fractal transformer, policy for authorization, and controller. It involves updating multiple files, including AuthServiceProvider for scopes.

Is this boilerplate compatible with Lumen 8 or newer PHP versions?

The README specifies Lumen 5.5, so compatibility isn't guaranteed. You might need to manually update dependencies and adjust code for newer versions, as no migration guide is provided.

What's the difference between using Fractal and Laravel's API resources in this setup?

Fractal offers advanced features like includes and meta-data for complex transformations, but adds an external dependency. Laravel's built-in API resources are lighter but less flexible; this boilerplate chooses Fractal for consistency across responses.

How does scope-based authorization work with OAuth2 here?

It uses Laravel Passport where tokens are issued with specific scopes (e.g., 'users:read'), and endpoints are protected with middleware like 'scope:users:read'. The README shows custom access token creation to restrict scope assignment.

Can I use this for microservices or is it too heavy?

While Lumen is lightweight, the boilerplate includes Passport and Fractal, which add overhead. For ultra-minimal microservices, a bare Lumen setup without these features might be more suitable.

How to deploy this API to a cloud server like AWS?

The README doesn't cover deployment, but standard practices apply: set environment variables, secure Passport keys, configure databases, and use Lumen's built-in server or a web server like Nginx. External tutorials are needed for specifics.

Lumen or Laravel for building REST APIs, and why use this boilerplate?

Lumen is faster and minimal for APIs, while Laravel has more full-stack features. This boilerplate accelerates Lumen development with pre-built security and architecture, but locks you into its patterns compared to starting from scratch.

Open-Awesome

REST API With Lumen

PHP

A RESTful API boilerplate for Lumen micro-framework with OAuth2 authentication, repository pattern, and fractal transformers.

GitHub

483 stars136 forks0 contributors

What is REST API With Lumen?

REST API with Lumen is a boilerplate project for quickly building secure and feature-rich RESTful APIs using the Lumen micro-framework. It solves the problem of repetitive setup by providing pre-configured authentication, authorization, data transformation, and testing tools, enabling developers to jumpstart API development with best practices.

Target Audience

PHP developers and teams building RESTful APIs with Lumen who need a structured, production-ready starting point with built-in security and testing features.

Value Proposition

Developers choose this boilerplate because it offers a comprehensive set of essential API features out-of-the-box, follows clean architectural patterns like Repository and Transformer, and reduces initial setup time while enforcing consistency and security.

Overview

Rest API boilerplate for Lumen micro-framework.

Use Cases

Best For

Quickly starting new Lumen-based API projects
Building secure APIs with OAuth2 authentication
Implementing repository pattern in PHP APIs
Creating consistent API responses with Fractal
Developing APIs with scope-based authorization
Setting up tested and maintainable API codebases

Not Ideal For

Projects using non-PHP stacks or preferring lightweight frameworks without Laravel ecosystem dependencies
Simple APIs where OAuth2 authentication and Fractal transformers add unnecessary complexity
Teams requiring GraphQL, WebSocket, or real-time features out-of-the-box
Developers unfamiliar with Lumen who might struggle with the multi-step setup and configuration

Pros & Cons

Pros

Robust OAuth2 Security

Integrates Laravel Passport for secure token-based authentication with scope-based authorization, as demonstrated in the custom access token creation route and scope middleware for endpoints.

Clean Architectural Patterns

Enforces Repository Pattern and Fractal Transformers, promoting testable code and consistent API responses, evidenced in the step-by-step guide for adding new resources like messages.

Comprehensive Testing Setup

Includes built-in endpoint and unit tests with Travis CI integration, ensuring reliability from the start, as listed in the key features and README.

Production-Ready Features

Comes pre-configured with CORS support, rate limiting, event handling, and mailing via Mailable, reducing initial setup time for scalable APIs.

Cons

Complex Initial Setup

Requires multiple manual steps like database creation, Passport client installation, and service provider updates, which can be cumbersome for quick prototypes.

Tied to Outdated Lumen Version

Based on Lumen 5.5 without clear upgrade paths, potentially missing newer PHP features or security updates from later Lumen releases.

Opinionated Architecture Overhead

Mandates patterns like Repository and Fractal, which might not suit teams preferring simpler Laravel Eloquent or different response formatting methods.

Frequently Asked Questions

Related Projects

Voyager

Voyager - The Missing Laravel Admin

Stars11,815

Forks2,659

Last commit1 year ago

Laravel Admin

Build a full-featured administrative interface in ten minutes

Stars11,154

Forks2,833

Last commit2 months ago

Dingo API

A RESTful API package for the Laravel and Lumen frameworks.

Stars9,360

Forks1,272

Last commit4 years ago

laravel-5-boilerplate

The Laravel Boilerplate Project - https://laravel-boilerplate.com

Stars5,634

Forks1,562

Last commit9 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub