viralsbackpack / backpackapi
Backpack 中的 CRUD API
1.0
2019-04-25 14:34 UTC
Requires
Requires (Dev)
- mockery/mockery: ^1.1
- orchestra/testbench: ~3.0
- phpunit/phpunit: ~7.0
- sempro/phpunit-pretty-print: ^1.0
This package is auto-updated.
Last update: 2024-09-26 03:16:11 UTC
README
快速为你的 Eloquent 模型构建 API 接口,使用 Laravel 5,每 10 分钟/模型最多 10 分钟即可搭建一个完整的 CMS。
特性
- CRUD 和搜索调用 API
- 使用 Requests 在后端进行验证
- 轻松覆盖功能(在 EntityCrudAPICrontroller 中创建一个新函数以自定义创建/更新/删除过程的工作方式)
安装
composer require viralsbackpack/backpackapi
设置
1. 命令
创建控制器并添加 API 路由
php artisan backpack:crud-api name
此命令将在 app/Http/Api 文件夹中创建 NameAPICrudController,并在 routes/backpack/api.php 中添加 api 资源路由
或特定命令
创建控制器
php artisan backpack:crud-api-controller Name
添加 API 路由
php artisan backpack-api:add-custom-route "BackPackAPI::resource('name', 'NameCrudAPIController');"
2. 设置 API
以下所有设置都可以添加到控制器中的任何方法。
添加验证请求
<?php $this->setRequestStoreApi(StoreRequest::class); $this->setRequestUpdateApi(UpdateRequest::class);
设置响应中的结构数据
<?php // Set up structure of data in response $this->crud->setResponse([ 'id', 'name' //fields of its model ]);
或自定义字段
<?php $this->crud->setResponse([ 'name' => function($entry) { return $entry->name . '123'; }, 'id' => function($entry) { return $entry->id . '123'; } ]);
设置额外数据
<?php $this->crud->setExtraData([ 'test' => 123 ]);
设置删除后返回的列表条目
<?php $this->crud->setDeleteReturnList(true);
设置消息
<?php $this->crud->setMessage('message');
设置状态
<?php $this->crud->setStatus(123);
使用方法
致谢
- [作者姓名][manhhd@viralsoft.vn]
许可协议
许可协议。请参阅许可文件以获取更多信息。