Docs (#88)

* Auth documentation

* Auth documentation

* Main readme

* Field docs

* Rest methods

* Apply fixes from StyleCI (#84)

* Exception handler

* Apply fixes from StyleCI (#85)

* Homepage

* Search documentation

* Apply fixes from StyleCI (#86)

* Main

* Align meta and links

* Apply fixes from StyleCI (#87)

* Format related for details into the according repository

* Remove throw doc.

* Apply fixes from StyleCI (#89)

* Fix test

Author: Lupacescu Eduard

config/config.php

@@ -5,7 +5,15 @@
 
 return [
     'auth' => [
-        //Table with authenticatable resource
+        /*
+    |--------------------------------------------------------------------------
+    | Table containing authenticatable resource
+    |--------------------------------------------------------------------------
+    |
+    | This configuration contain the name of the table used for the authentication.
+    |
+    */
+
         'table' => 'users',
     ],
 
@@ -14,9 +22,8 @@
     | Restify Base Route
     |--------------------------------------------------------------------------
     |
-    | These middleware will be assigned to every Restify route, giving you the
-    | chance to add your own middleware to this stack or override any of
-    | the existing middleware. Or, you can just stick with this stack.
+    | This configuration is used as a prefix path where Restify will be accessible from.
+    | Feel free to change this path to anything you like.
     |
     */
 

docs/.vuepress/config.js

@@ -28,17 +28,21 @@ module.exports = {
                 path: '/docs/repository-pattern/field',
             },
             {
-                title: 'REST methods',
+                title: 'Rest Controller',
                 path: '/docs/rest-methods/rest-methods',
             },
             {
-                title: 'Error handler',
-                path: '/docs/exception-handler/exception-handler',
+                title: 'Filtering',
+                path: '/docs/search/search',
             },
             {
                 title: 'Auth service',
                 path: '/docs/auth/auth',
             },
+            {
+                title: 'Error handler',
+                path: '/docs/exception-handler/exception-handler',
+            },
         ]
     },
     plugins: [

docs/README.md

@@ -2,14 +2,21 @@
 home: true
 heroImage: /assets/img/logo.svg
 heroText: Laravel Restify
-tagline: REST API + Auth
-actionText: Just do it →
+tagline: A package to start a Rest API
+actionText: Docs →
 actionLink: /docs/
 features:
+- title: Magic CRUD over entities
+  details: Enjoy powerful "CRUD" over your entities in seconds
 - title: Authentication with Passport
-  details: Login, register, reset password, forgot password emails served for you
-- title: Powerful Response maker
-  details: Enjoy the dev experience of Laravel API by using handy response helpers
-- title: Generic Exceptions
-  details: Exceptions we usually use in every API project. Easy way of handling exception in your frontend application.
+  details: Login, register, reset password, forgot password emails - served for you
+- title: Handy Response maker
+  details: Enjoy the dev experience of Restify API by using consistent response helpers
+- title: Powerful Searching
+  details: Built in filtering, sorting, matching and much more configurable features
+- title: Exception handler
+  details: Make your API more suggestive by giving readable exceptions
+- title: JSON:API consistency
+  details: Maintain your API consistent according with https://jsonapi.org
+  
 footer: MIT Lice

docs/docs/README.md

@@ -15,71 +15,50 @@ Laravel Restify has a few requirements you should be aware of before installing:
 composer require binaryk/laravel-restify
 ```
 
+## Setup Laravel Restify
+After the instalation, the package requires a setup process, this will publish configuration, provider and will create the 
+`app/Restify` directory with an abstract `Repository` and scaffolding a `User` repository you can play with:
+
+```shell script
+php artisan restify:setup
+```
+
 :::tip Package Stability
 
-If you are not able to install Restify into your application because of your `minimum-stability` setting, consider setting your `minimum-stability` option to `dev` and your `prefer-stable` option to `true`. This will allow you to install Laravel restify while still preferring stable package releases for your application.
+If you are not able to install Restify into your application because of your `minimum-stability` setting,
+ consider setting your `minimum-stability` option to `dev` and your `prefer-stable` option to `true`. 
+ This will allow you to install Laravel Restify while still preferring stable package 
+ releases for your application.
 :::
 
-That's it! 
-
-Next, you may extend the `Binaryk\LaravelRestify\Controllers\RestController` and use its helpers:
-
-```php
-class UserController extends RestController 
-{
-    /**
-     * Display a listing of the resource.
-     *
-     * @return JsonResponse
-     */
-    public function index()
-    {
-        $users = User::all();
-
-        return $this->respond($users);
-    }
-}
+## Quick start
+
+Having the package setup and users table migrated, you should be good to perform the first API request:
+
+```http request
+GET: /restify-api/users?perPage=10
 ```
 
-## Authentication service
-
-For each API we have to implement the auth module from scratch. With Laravel Restify this is not a pain anymore:
-
-```php
-class AuthController extends Binaryk\LaravelRestify\Controllers\RestController
-{
-    /**
-         * @var Binaryk\LaravelRestify\Services\AuthService
-         */
-        protected $authService;
-    
-        public function __construct(Binaryk\LaravelRestify\Services\AuthService $authService)
-        {
-            $this->authService = $authService;
-        }
-    
-        /**
-        * @param RestifyLoginRequest $request
-        * @return Illuminate\Http\JsonResponse|string|void
-        * @throws \Binaryk\LaravelRestify\Exceptions\CredentialsDoesntMatch
-        * @throws \Binaryk\LaravelRestify\Exceptions\PassportUserException
-        * @throws \Binaryk\LaravelRestify\Exceptions\UnverifiedUser
-        */
-        public function login(RestifyLoginRequest $request)
-        {
-            $credentials = $request->only('email', 'password');
-            $response = $this->response();
-    
-            try {
-                $token = $this->authService->login($credentials);
-    
-                $response->data(['token' => $token])->message(__('Authentication with success'));
-            } catch (CredentialsDoesntMatch | UnverifiedUser | PassportUserException $e) {
-                $response->addError($e->getMessage())->auth();
-            }
-    
-            return $response->respond();
-        }
-}
+This should return the users list paginated and formatted according to [JSON:API](https://jsonapi.org/format/) standard.
+
+## Generate repository
+
+Creating a new repository can be done via restify command: 
+
+```shell script
+php artisan restify:repository Post
+```
+
+If you want to generate the Policy, Model and migration as well, then you can use the `--all` option:
+
+```shell script
+php artisan restify:repository Post --all
 ```
+## Generate policy 
+
+Since the authorization is done through the Laravel Policies, a good way of generating a complete policy for an entity
+is by using the restify command:
 
+```shell script
+php artisan restify:policy Post
+```