To install this package you will need:
Laravel 5.1+ or Lumen 5.1+
PHP 5.5.9+
You must then modify your composer.json
file and run composer update
to include the latest version of the package in your project.
"require": { "dingo/api": "1.0.*@dev"}
Or you can run the composer require
command from your terminal.
composer require dingo/api:1.0.x@dev
At this time the package is still in a developmental stage and as such does not have a stable release. You may need to set your minimum-stability
to dev
.
Once the package is installed the next step is dependant on which framework you're using.
[
](https://github.com/dingo/api/wiki/Installation#laravel)Laravel
Open config/app.php
and register the required service provider above your application providers.
'providers' => [ Dingo\Api\Provider\LaravelServiceProvider::class]
If you'd like to make configuration changes in the configuration file you can pubish it with the following Aritsan command:
php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"
[
](https://github.com/dingo/api/wiki/Installation#lumen)Lumen
Open bootstrap/app.php
and register the required service provider.
$app->register(Dingo\Api\Provider\LumenServiceProvider::class);
[
](https://github.com/dingo/api/wiki/Installation#facades)Facades
There are two facades shipped with the package. You can add either of them should you wish.
[
](https://github.com/dingo/api/wiki/Installation#dingoapifacadeapi)Dingo\Api\Facade\API
This is a facade for the dispatcher, however, it also provides helper methods for other methods throughout the package.
[
](https://github.com/dingo/api/wiki/Installation#dingoapifacaderoute)Dingo\Api\Facade\Route
This is a facade for the API router and can be used to fetch the current route, request, check the current route name, etc.
