PHPackages redmarbakker/via-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. redmarbakker/via-rest ActiveProject[HTTP & Networking](/categories/http) redmarbakker/via-rest ===================== Laravel REST api package. v0.2(6y ago)11.4kMITPHPPHP ^7.1.3CI failing Since Jun 5Pushed 4y ago1 watchersCompare [ Source](https://github.com/RedmarBakker/via-rest)[ Packagist](https://packagist.org/packages/redmarbakker/via-rest)[ RSS](/packages/redmarbakker-via-rest/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (2)Dependencies (4)Versions (4)Used By (0) A Laravel REST Provider. Plug-and-play module for creating REST API routes with models. Installation ------------ [](#installation) `composer.json`: ``` { "require": { ... "redmarbakker/via-rest": "^0.0" }, "repositories": [ { "type": "vcs", "url": "https://github.com/redmarbakker/via-rest" } ] } ``` Setting up a Model ------------------ [](#setting-up-a-model) `app/Models/Order.php`: ``` namespace App\Models; use Illuminate\Database\Eloquent\Model; use ViaRest\Models\DynamicModelInterface; use ViaRest\Models\DynamicModelTrait; class Order extends Model implements DynamicModelInterface { use DynamicModelTrait; ... } ``` Setting up a Controller ----------------------- [](#setting-up-a-controller) In this case we modify our create because we want to do something specific on a create. `app/Http/Controllers/Api/OrderController.php`: ``` namespace App\Http\Controllers\Api; use Illuminate\Http\JsonResponse; use ViaRest\Http\Controllers\Api\AbstractRestController; use ViaRest\Http\Controllers\Api\RestControllerInterface; use ViaRest\Models\DynamicModelInterface; use App\Models\Order; class OrderController extends AbstractRestController implements RestControllerInterface { /** * @return DynamicModelInterface */ public function getModel(): DynamicModelInterface { return new Order(); } /** * @param $input array * @return JsonResponse * */ public function doCreate(array $input): JsonResponse { ... return parent::doCreate($input); } ... } ``` Configuring your routes ----------------------- [](#configuring-your-routes) A basic model example. `routes/api.php:`: ``` use ViaRest\Http\Router\ViaRest; ViaRest::handle('v1', [ /** * All REST API routes * * uri => provider * */ 'orders' => ViaRest::model(Order::class), ]); ``` A basic controller example. `routes/api.php`: ``` use ViaRest\Http\Router\ViaRest; ViaRest::handle('v1', [ /** * All REST API routes * * uri => provider * */ 'orders' => ViaRest::controller(OrderController::class), ]); ``` ### Configuring API routes with a relation [](#configuring-api-routes-with-a-relation) An example where there is an OneToMany relationship with orders. In this case an user can have multiple orders. Requesting this relation can be done with the following endpoint: /api/v1/users/1/orders. In this way orders can be fetched and an order can be created (GET, POST). `routes/api.php`: ``` use ViaRest\Http\Router\ViaRest; use App\Http\Controllers\Api\OrderController; use App\Models\User; use App\Models\Order; use App\Models\Product; ViaRest::handle('v1', [ /** * All REST API routes * * uri => provider * */ // GET: /api/v1/users/1/orders 'users' => ViaRest::model(User::class, [ 'orders' => Order::class ]), // GET: /api/v1/orders/1/products 'orders' => ViaRest::controller(OrderController::class, [ 'products' => Product::class ]), ]); ``` ### Configuring API routes with a custom endpoint [](#configuring-api-routes-with-a-custom-endpoint) An example where a custom endpoint is added where the frist array value is the method and the second array value is the method. `routes/api.php`: ``` use ViaRest\Http\Router\ViaRest; use App\Http\Controllers\Api\OrderController; use Illuminate\Http\Request; ViaRest::handle('v1', [ /** * All REST API routes * * uri => provider * */ // GET: /api/v1/orders/unhandled 'orders' => ViaRest::controller(OrderController::class, [], [ 'unhandled' => [Request::METHOD_GET, 'unhandled'] ]), ]); ``` `app/Http/Controllers/Api/OrderController.php`: ``` namespace App\Http\Controllers\Api; use ViaRest\Http\Controllers\Api\AbstractRestController; use ViaRest\Http\Controllers\Api\RestControllerInterface; use ViaRest\Models\DynamicModelInterface; use App\Http\Requests\Api\UnhandledRequest; use App\Model\Order; class OrderController extends AbstractRestController implements RestControllerInterface { /** * @return DynamicModelInterface */ public function getModel(): DynamicModelInterface { return new Order(); } public function unhandled(UnhandledRequest $request) { return ok([ 'data' => $this->getModel()->where('is_handled', false)->get() ]); } } ``` Validation your requests ------------------------ [](#validation-your-requests) Requests will be pickedup automatically. The abstract layer who will simulate the REST structure, will look for the Request with the following namespace: `{ModelPackageName}\Http\Requests\Api\{ModelName}\CreateRequest`, where in this case a create example were given. The following names will be used: `FetchRequest`, `FetchAllRequest`, `CreateRequest`, `UpdateRequest` & `DestroyRequest`. For example we will create a Request for our Order endpoint. `app/Http/Requests/Api/Orders/CreateRequest.php`: ``` namespace App\Http\Requests\Api\Orders; use ViaRest\Http\Requests\Api\CreateRequest as AbstractCreateRequest; use ViaRest\Http\Requests\Api\CrudRequestInterface; class CreateRequest extends AbstractCreateRequest implements CrudRequestInterface { public function authorize() { return true; } /** * Get the validation rules that apply to the request. * * @return array */ public function rules() { return [ 'user_id' => 'required', ]; } } ``` For custom routes, we can create Requests like the following code. In this example we use the previous senario where we gonna create a "UnhandledRequest". `app/Http/Requests/Api/Orders/UnhandledRequest.php`: ``` namespace App\Http\Requests\Api\Orders; use ViaRest\Http\Requests\Api\CrudRequestInterface; use ViaRest\Http\Requests\Api\AbstractRequest; class UnhandledRequest extends AbstractRequest implements CrudRequestInterface { /** * Get the validation rules that apply to the request. * * @return array */ public function rules() { return [ ]; } } ``` Response Examples ----------------- [](#response-examples) `GET: /api/v1/users/1`: ``` { "data": { "id": 1, "name": "John Doe", "email": "john.doe@domain.com", "email_verified_at": null, "created_at": "2019-05-29 17:27:44", "updated_at": "2019-05-29 17:27:44" } } ``` `GET: /api/v1/users`: ``` { "current_page": 1, "data": [ { "id": 1, "name": "John Doe", "email": "john.doe@domain.com", "email_verified_at": null, "created_at": "2019-05-29 17:27:44", "updated_at": "2019-05-29 17:27:44" }, { "id": 2, "name": "John Doe", "email": "john.doe@domain.com", "email_verified_at": null, "created_at": "2019-05-29 17:27:44", "updated_at": "2019-05-29 17:27:44" }, { "id": 3, "name": "John Doe", "email": "john.doe@domain.com", "email_verified_at": null, "created_at": "2019-05-29 17:27:44", "updated_at": "2019-05-29 17:27:44" } ], "first_page_url": "http://127.0.0.1:8000/api/v1/users?page=1", "from": 1, "last_page": 1, "last_page_url": "http://127.0.0.1:8000/api/v1/users?page=1", "next_page_url": null, "path": "http://127.0.0.1:8000/api/v1/users", "per_page": 15, "prev_page_url": null, "to": 3, "total": 3 } ``` `GET: /api/v1/users/1/orders`: ``` { "current_page": 1, "data": [ { "id": 1, "user_id": 1, "products": [ ... ], "created_at": "2019-06-04 23:20:56", "updated_at": "2019-06-04 23:20:56" }, { "id": 2, "user_id": 1, "products": [ ... ], "created_at": "2019-06-04 23:43:08", "updated_at": "2019-06-04 23:43:08" } ], "first_page_url": "http://127.0.0.1:8000/api/v1/orders?page=1", "from": 1, "last_page": 1, "last_page_url": "http://127.0.0.1:8000/api/v1/orders?page=1", "next_page_url": null, "path": "http://127.0.0.1:8000/api/v1/orders", "per_page": 15, "prev_page_url": null, "to": 2, "total": 2 } ``` ### Health Score 25 — LowBetter than 37% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity16 Limited adoption so far Community9 Small or concentrated contributor base Maturity46 Maturing project, gaining track record Bus Factor1 Top contributor holds 86% 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. ### Release Activity Cadence Every ~0 days Total 2 Last Release 2526d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/09a0f86a78d978a321d7494ce388774806e0512374124aa4bf8e76dfc1c4c0c0?d=identicon)[RedmarBakker](/maintainers/RedmarBakker) --- Top Contributors [![RedmarBakker](https://avatars.githubusercontent.com/u/15876733?v=4)](https://github.com/RedmarBakker "RedmarBakker (49 commits)")[![jessegall](https://avatars.githubusercontent.com/u/11755417?v=4)](https://github.com/jessegall "jessegall (8 commits)") --- Tags apilaravelrestvia-rest ### Embed Badge ![Health badge](/badges/redmarbakker-via-rest/health.svg) ``` [![Health](https://phpackages.com/badges/redmarbakker-via-rest/health.svg)](https://phpackages.com/packages/redmarbakker-via-rest) ``` ### Alternatives [francescomalatesta/laravel-api-boilerplate-jwt An API Boilerplate to create a ready-to-use REST API in seconds. 1.2k7.5k](/packages/francescomalatesta-laravel-api-boilerplate-jwt)[lomkit/laravel-rest-api A package to build quick and robust rest api for the Laravel framework. 59152.2k](/packages/lomkit-laravel-rest-api)[api-platform/laravel API Platform support for Laravel 59126.4k6](/packages/api-platform-laravel)[guanguans/laravel-api-response Normalize and standardize Laravel API response data structure. - 规范化和标准化 Laravel API 响应数据结构。 485.6k](/packages/guanguans-laravel-api-response)[xtend-packages/rest-presenter REST API Presenter & Generator for Laravel 771.5k](/packages/xtend-packages-rest-presenter) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)