PHPackages                             alissonphp/lumen-api-skeleton - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. alissonphp/lumen-api-skeleton

ActiveProject[Authentication & Authorization](/categories/authentication)

alissonphp/lumen-api-skeleton
=============================

Lumen API skeleton with JWT to manager tokens, Socialite to OAuth Providers, MongoDB driver and Predis to Redis cache storage.

2185PHP

Since Aug 31Pushed 8y ago1 watchersCompare

[ Source](https://github.com/alissonphp/lumen-api-skeleton)[ Packagist](https://packagist.org/packages/alissonphp/lumen-api-skeleton)[ RSS](/packages/alissonphp-lumen-api-skeleton/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

Rest API Lumen Skeleton
=======================

[](#rest-api-lumen-skeleton)

Basic structure for creating REST APIs using Lumen Framework and extra packages

### System requirements

[](#system-requirements)

- PHP >= 5.6.4
- OpenSSL PHP Extension
- PDO PHP Extension
- Mbstring PHP Extension
- Mongo DB drive
- PHPUnit
- Redis Drive

### Installation

[](#installation)

```
$ git clone https://github.com/alissonphp/lumen-api-skeleton
$ cd lumen-api-skeleton/
```

IMPORTANT: configure .env (copy .env.example) at the root of the application with the development variables: connections with MySQL and MongoDB, APP Ids of the authentication services (google, facebook).

```
$ composer install
$ php artisan jwt:secret
$ php artisan migrate
$ php artisan db:seed
$ php -S localhost:8000 -t public
```

Development server running in:

### Packages Used

[](#packages-used)

- Lumen Micro Framework \[\]
- Socialite \[\]
- JWT Auth \[\]
- Laravel MongoDB \[\]
- Predis \[\]

### Modularization

[](#modularization)

The application is architected in Modules. Each module has defined responsibility and Layers. The standard model of a module follows the following structure:

```
app
└───Modules
│   │   Controllers
│   │   Events
│   │   Listeners
│   │   Middlewares
│   │   Models
│   │   Supports
│   │   Tests
│   │   routes.php

```

To enable / disable the functionality of a module simply inform the Namespace in the array of the config / modules.php file Important to verify interoperability between modules before deactivating it.

### Routes

[](#routes)

Routes are defined in the routes.php files within the root directory of each module. The RouteServiceProvider is responsible for loading the routes of each module defined in config / modules.php. No need to instantiate new calls.

### Endpoints composition

[](#endpoints-composition)

- Model : localhost:8000 + api version + module namespace + action + parameters, for example:  or

### Tests

[](#tests)

There are two types of tests: Integration and Unit. The default directory where the cases should be is /Tests within the module under development. For integration tests use the "test + type + Test" naming standard, for example: LoginIntegrationTest (test: Login, type: Integration).

Run the tests using the command referencing the testsuite as 'unit' or 'integration':

```
$ phpunit --testsuite integration
$ phpunit --testsuite unit
```

### Contributions

[](#contributions)

The purpose of this repository is to create a fast model for implementing REST APIs using the Lumen Framework. We still have enough to get close to an "ideal" model: rules for accessing endpoints, improving standards, writing tests, translations, etc.

#### Fork, enjoy and join us in this project! Send yours pull requests, share to your friends.

[](#fork-enjoy-and-join-us-in-this-project-send-yours-pull-requests-share-to-your-friends)

###  Health Score

24

—

LowBetter than 31% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 92.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/02dfda1fd64367689db641a74037725eee99542ec63097c70e93eb09505f676f?d=identicon)[alissonphp](/maintainers/alissonphp)

---

Top Contributors

[![alissonphp](https://avatars.githubusercontent.com/u/907860?v=4)](https://github.com/alissonphp "alissonphp (12 commits)")[![evaldobarbosa](https://avatars.githubusercontent.com/u/588455?v=4)](https://github.com/evaldobarbosa "evaldobarbosa (1 commits)")

---

Tags

apijwtlumenmongodboauthphp

### Embed Badge

![Health badge](/badges/alissonphp-lumen-api-skeleton/health.svg)

```
[![Health](https://phpackages.com/badges/alissonphp-lumen-api-skeleton/health.svg)](https://phpackages.com/packages/alissonphp-lumen-api-skeleton)
```

###  Alternatives

[kartik-v/yii2-password

Useful password strength validation utilities for Yii Framework 2.0

761.3M17](/packages/kartik-v-yii2-password)[vitalybaev/laravel5-dkim

Laravel 5/6 package for signing outgoing messages with DKIM.

3163.1k](/packages/vitalybaev-laravel5-dkim)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)