Guide
Getting Started
Take the first steps to start using Orion.
Requirements
- PHP >= 7.2
- Laravel >= 5.7
Installation
Orion can be installed into a new or existing project, simply by adding a composer dependency:
composer require tailflow/laravel-orion
Simple CRUD
Let's assume you have a model Post that represents a blog post and you would like to manage it via REST API.
With Orion it can be acomplished in 3 simple steps:
- Create
PostsControllerand extend it fromOrion\Http\Controllers\Controller
<?php
namespace App\Http\Controllers\Api;
use App\Models\Post;
use Orion\Http\Controllers\Controller;
class PostsController extends Controller
{
}
- Then define
protected $modelproperty and set it to the fully-qualified model class name. The complete controller should look like this
<?php
namespace App\Http\Controllers\Api;
use Orion\Http\Controllers\Controller;
class PostsController extends Controller
{
/**
* Fully-qualified model class name
*/
protected $model = Post::class; // or "App\Models\Post"
}
By default Laravel is not shipped with
API folder in app/Http/Controllers, but it is recommended to create one and store all API controllers there to keep the code organized.Make sure to have policy created and registered for the model you are exposing via the API or consider using
DisableAuthorization trait (only for local testing) to avoid getting 403 error, if the policy is not registered or incorrect.Request classes must extend
Orion\Http\Requests\Request class instead of Illuminate\Foundation\Http\FormRequest- Finally, register the route in
api.phpby callingOrion::resource
<?php
use Illuminate\Support\Facades\Route;
use Orion\Facades\Orion;
use App\Http\Controllers\PostsController;
Route::group(['as' => 'api.'], function() {
Orion::resource('posts', PostsController::class);
});
Done 🎉 Now you can create, list, search, view, update, and delete blog posts via REST API. Try to create a post via (POST) https://<your app url>/api/posts endpoint 😉
You can also take a look at all available endpoints by running php artisan route:list command
+--------+-----------+-------------------------------------------------+----------------------------------------+---------------------------------------------------------------------------+-------------------------------------------------+
| Domain | Method | URI | Name | Action | Middleware |
+--------+-----------+-------------------------------------------------+----------------------------------------+---------------------------------------------------------------------------+-------------------------------------------------+
...
| | GET|HEAD | api/posts | api.posts.index | App\Http\Controllers\Api\PostsController@index | api |
| | POST | api/posts/search | api.posts.search | App\Http\Controllers\Api\PostsController@index | api |
| | POST | api/posts | api.posts.store | App\Http\Controllers\Api\PostsController@store | api |
| | GET|HEAD | api/posts/{post} | api.posts.show | App\Http\Controllers\Api\PostsController@show | api |
| | PUT|PATCH | api/posts/{post} | api.posts.update | App\Http\Controllers\Api\PostsController@update | api |
| | DELETE | api/posts/{post} | api.posts.destroy | App\Http\Controllers\Api\PostsController@destroy | api |
| | POST | api/posts/batch | api.posts.batchStore | App\Http\Controllers\Api\PostsController@batchStore | api |
| | PATCH | api/posts/batch | api.posts.batchUpdate | App\Http\Controllers\Api\PostsController@batchUpdate | api |
| | DELETE | api/posts/batch | api.posts.batchDestroy | App\Http\Controllers\Api\PostsController@batchDestroy | api |