文档地址 https://learnku.com/docs/dingo-api/2.0.0/Installation/1443
一. 安装和配置
(1)在cmd用管理员身份打开使用命令 composer require dingo/api
在执行composer安装命令的时候如果显示内存不足
$COMPOSER_MEMORY_LIMIT=-1 composer require dingo/api (执行命令)
(2)API 的配置文件到 config
文件下
php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"
(3)配置信息可以添加的几个配置添加在env里面加在最后面(*这个用来隔离)
*API_STANDARDS_TREE=x *API_SUBTYPE=shop(myapp是自己给予名字)
*API_PREFIX=api *API_VERSION=v1 *API_NAME="shop"(自己给定的名字)
*API_CONDITIONAL_REQUEST=false *API_STRICT=false *API_DEFAULT_FORMAT=json
*API_DEBUG=true(上线的时候给删除)
二. 端点和响应
(1)删除route/api.php文件下的代码只保留<?php
(2)添加代码 $api = app('Dingo\Api\Routing\Router');
(3)写东西之前先定义一个版本分组
$api->version('v1', function ($api) { });$api->version('v2', function ($api) { });
(4)代码路由写在版本分组里面
$api->version('v1', function ($api) {
$api->get('users/{id}', 'App\Api\Controllers\UserController@show');
1.这个是命名路由
$api->get('users/{id}', ['as' => 'users.index', 'uses' => 'Api\V1\UserController@show']);
})
(5)查看所有的api路由 $ php artisan api:routes
三. 响应
(1)返回数据集合 return User::all();
(2)返回单个数据 return User::find(1);
(3)响应生成器 (涉及到transform留到后面讲)
use Dingo\Api\Routing\Helpers; 放到Controller.php里面
use Helpers; 放到里面
(4)无内容相应 return $this->response->noContent(); 状态码204无状态
(5)创建了资源响应 return $this->response->created(); 状态码201创建内容
(6)错误响应 return $this->response->error('This is an error.', 404);
(7)错误的响应和代码提示
可以继承他们进行使用
throw new Symfony\Component\HttpKernel\Exception\ConflictHttpException('自己定义消息');
错误消息多去看文档
四. transformers 一个模型对应一个transformer
(1)在app文件夹下面新建一个Transformers文件夹,然后新建一个类Usertransformer.php,让他继承TransformerAbstract,public function transform(User $user){ return [
'id'=>$user->id,'name'=>$user->name,'email'=>$user->email]; }}
(2)响应一个元素使用
$user = User::findOrFail($id);
return $this->response->item($user, new Usertransformer)
(3)响应一个数组
$users = User::all();
return $this->response->collection($users, new UserTransformer);
(4)响应一个分页
$users = User::paginate(25);
return $this->response->paginator($users, new UserTransformer);
(5)添加头信息
return $this->response->item($user, new UserTransformer)->withHeader('X-Foo', 'Bar');
(6)添加meta信息
return $this->response->item($user, new UserTransformer)->addMeta('foo', 'bar');
(7)设置状态码
return $this->response->item($user, new UserTransformer)->setStatusCode(200);