PHPackages                             lujo/lumen-rest - 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. [HTTP & Networking](/categories/http)
4. /
5. lujo/lumen-rest

ActiveLibrary[HTTP & Networking](/categories/http)

lujo/lumen-rest
===============

Lumen package for creating simple REST API

2.0.0(2y ago)197MITPHPPHP >=8.0.0CI failing

Since Jun 5Pushed 2y ago1 watchersCompare

[ Source](https://github.com/lmatosevic/lumen-rest)[ Packagist](https://packagist.org/packages/lujo/lumen-rest)[ RSS](/packages/lujo-lumen-rest/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (3)Versions (34)Used By (0)

Lumen REST
==========

[](#lumen-rest)

> Lumen package for creating simple REST APIs.

Installation
------------

[](#installation)

Install the package using composer by executing following command:

```
composer require lujo/lumen-rest
```

Or you can add in `composer.json` the followign line:

```
"require": {
    ...
    "lujo/lumen-rest": "*"
}
```

And then run:

```
composer install
```

Description
-----------

[](#description)

This Lumen package consists of two classes: `RestRoute` and `RestController`.

- `RestRoute` does all the routing operations in function `route(...)` for specific resource.
- `RestController` should be extended by some other controller class for specific resource.

Usage
-----

[](#usage)

### 1. Create Eloquent model

[](#1-create-eloquent-model)

In order to use this REST package, first you must create eloquent model for some resource.

Example Article model:

```