Dingo Api 1.0在laravel5.2中的简单应用
Dingo Api
是为基于laravel
的开发提供了一系列工具集,这些工具集可以帮助开发者快速构建API
。Dingo Api
最新的版本是2.0.0-alpha1
,这个版本需要php7.0
以上的php
版本的支撑,笔者这里以Dingo Api 1.0
为例简单介绍其在laravel5.2中的应用。
安装Dingo Api
在
composer.json
中的require
中添加"dingo/api": "1.0.*@dev"
composer.json执行
composer update
composer update
配置Dingo Api
- 在
config/app.php
的providers
中增加Dingo\Api\Provider\LaravelServiceProvider::class,
- 执行
php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"
以生成config
下配置文件vendor:publish - 在
config/app.php
的aliases
中添加'Api' => Dingo\Api\Facade\API::class,
- 配置
config/api.php
需要配置的内容如下:
'standardsTree' => env('API_STANDARDS_TREE', 'vnd'), // 项目需要能被公开访问
'subtype' => env('API_SUBTYPE', 'blog'), // 根据项目名称配置
'prefix' => env('API_PREFIX', 'api'), // 可以根据需求去设置 这里设置成api
'name' => env('API_NAME', 'Blog Api'), // 根据项目设置
'debug' => env('API_DEBUG', true), // 开启调试便于开发 上线后关闭之
创建API路由
创建
App\Http\Controllers\Api\V1\UserController.php
创建控制器创建
API
路由器
// 在app/Http/routes.php中增加
$api = app('Dingo\Api\Routing\Router');
- 创建以版本为单位的路由组
// 在app/Http/routes.php中增加
$api->version('v1', function ($api) {
$api->get('user/{id}', ['as' => 'user.show', 'uses' => 'App\Http\Controllers\Api\V1\UserController@show']); // 注意此处controller要写完整命名空间
});
- 生成
URL
// 在app/Http/routes.php中增加
app('Dingo\Api\Routing\UrlGenerator')->version('v1')->route('user.show', 'id');
- 最终代码概览
// 在app/Http/routes.php中增加
$api = app('Dingo\Api\Routing\Router');
$api->version('v1', function ($api) {
$api->get('user/{id}', ['as' => 'user.show', 'uses' => 'App\Http\Controllers\Api\V1\UserController@show']); // 注意此处controller要写完整命名空间
});
app('Dingo\Api\Routing\UrlGenerator')->version('v1')->route('user.show', 'id');
在控制台查看路由
查看路由
创建API并访问
- 完善
App\Http\Controllers\Api\V1\UserController
添加代码如下:
<?php
namespace App\Http\Controllers\Api\V1;
use App\Http\Controllers\Controller;
// 这里可以去掉没用的内容
use App\User; // 引用模型
class UserController extends Controller
{
public function show($id) // 接口方法
{
return User::findOrFail($id);
}
}
访问接口
访问接口
响应构建器
通过响应构建器可以构建更多自定义响应。
创建基类
创建基类填充基类内容
具体代码如下:
<?php
namespace App\Http\Controllers\Api\V1;
// 自动生成的内容可以去掉
use Dingo\Api\Routing\Helpers; // trait
use Illuminate\Routing\Controller; // 增加
class BaseController extends Controller
{
use Helpers;
}
- 继承基类
修改App\Http\Controllers\Api\V1\UserController
为:
<?php
namespace App\Http\Controllers\Api\V1;
use App\Http\Controllers\Api\V1\BaseController; // 此处有调整
use App\User; // 引用模型
class UserController extends BaseController // 此处有调整
{
public function show($id) // 接口方法
{
return User::findOrFail($id);
}
}
- 数组响应
修改接口代码为:
public function show($id) // 接口方法
{
$user = User::findOrFail($id);
return $this->response->array($user->toArray());
}
增加一个获取全部用户数据的接口
- 修改路由
$api = app('Dingo\Api\Routing\Router');
$api->version('v1', function ($api) {
$api->get('user/{id}', ['as' => 'user.show', 'uses' => 'App\Http\Controllers\Api\V1\UserController@show']); // 注意此处controller要写完整命名空间
$api->get('user', ['as' => 'user.index', 'uses' => 'App\Http\Controllers\Api\V1\UserController@index']); // 注意此处controller要写完整命名空间 增加行
});
app('Dingo\Api\Routing\UrlGenerator')->version('v1')->route('user.show', 'id');
app('Dingo\Api\Routing\UrlGenerator')->version('v1')->route('user.index'); // 增加行
- 增加接口
在App\Http\Controllers\Api\V1\UserController
增加方法:
public function index()
{
return User::all();
}
- 数组响应
修改App\Http\Controllers\Api\V1\UserController
的index
方法:
public function index()
{
$users = User::all();
return $this->response->array($users->toArray());
}
构建转换器
转换器用于对数据进行过滤和转化用以提供更加人性化的数据。
- 添加
App\Transformers\Api\V1\UserTransformer.php
具体代码如下:
<?php
namespace App\Transformers\Api\V1;
use League\Fractal\TransformerAbstract;
use App\User;
class UserTransformer extends TransformerAbstract
{
public function transform(User $user)
{
return [
'name' => $user->name,
'email' => $user->email,
'created_at' => date('Y-m-d', strtotime($user->created_at))
];
}
}
- 使用转换器
修改App\Http\Controllers\Api\V1\UserController
:
<?php
namespace App\Http\Controllers\Api\V1;
use App\Http\Controllers\Api\V1\BaseController;
use App\Transformers\Api\V1\UserTransformer; // 增加行
use App\User; // 引用模型
class UserController extends BaseController
{
public function index()
{
$users = User::all();
return $this->response->array($users->toArray());
}
public function show($id) // 接口方法
{
$user = User::findOrFail($id);
return $this->response->item($user, new UserTransformer); //修改
}
}
实现分页
执行
php artisan make:seeder UsersTableSeeder
make:seeder修改
database\seeds\UsersTableSeeder.php
<?php
use Illuminate\Database\Seeder;
class UsersTableSeeder extends Seeder
{
/**
* Run the database seeds.
*
* @return void
*/
public function run()
{
factory(App\User::class, 50)->create(); // 增加一行
}
}
执行
php artisan db:seed --class=UsersTableSeeder
db:seedusers修改
App\Http\Controllers\Api\V1\UserController
的index
方法:
public function index()
{
$users = User::paginate(8);
return $this->response->paginator($users, new UserTransformer);
}
更多响应
- 指定信息和状态码的错误响应
public function index()
{
/* $users = User::paginate(8);
return $this->response->paginator($users, new UserTransformer); */
return $this->response->error('This is an error.', 404);
}
- 未找到错误响应
public function index()
{
/* $users = User::paginate(8);
return $this->response->paginator($users, new UserTransformer); */
return $this->response->errorNotFound();
}
- 坏请求错误响应
public function index()
{
/* $users = User::paginate(8);
return $this->response->paginator($users, new UserTransformer); */
return $this->response->errorBadRequest();
}
- 禁止访问错误响应
public function index()
{
/* $users = User::paginate(8);
return $this->response->paginator($users, new UserTransformer); */
return $this->response->errorForbidden();
}
- 内部错误错误响应
public function index()
{
/* $users = User::paginate(8);
return $this->response->paginator($users, new UserTransformer); */
return $this->response->errorInternal();
}
- 未认证错误响应
public function index()
{
/* $users = User::paginate(8);
return $this->response->paginator($users, new UserTransformer); */
return $this->response->errorUnauthorized();
}
- 添加响应头
public function show($id) // 接口方法
{
$user = User::findOrFail($id);
return $this->response->item($user, new UserTransformer)->withHeader('author', 'stone');
}
- 添加元数据
public function show($id) // 接口方法
{
$user = User::findOrFail($id);
return $this->response->item($user, new UserTransformer)->addMeta('author', 'stone');
}
public function show($id) // 接口方法
{
$user = User::findOrFail($id);
return $this->response->item($user, new UserTransformer)->setMeta(['author' => 'stone', 'date' => date('Y-m-d')]);
}
- 设置响应状态码
public function show($id) // 接口方法
{
$user = User::findOrFail($id);
return $this->response->item($user, new UserTransformer)->setStatusCode(202);
}
为接口增加权限控制
这一步需要提供oAuth
的支持,可参考oAuth2.0在laravel5.2中的简单应用
- 在路由定义上加入
oAuth
中间件
$api->version('v1', ['middleware' => 'oauth'], function ($api) { // 加上中间件
$api->get('user/{id}', ['as' => 'user.show', 'uses' => 'App\Http\Controllers\Api\V1\UserController@show']); // 注意此处controller要写完整命名空间
$api->get('user', ['as' => 'user.index', 'uses' => 'App\Http\Controllers\Api\V1\UserController@index']); // 注意此处controller要写完整命名空间
});
- 获取
access_token
创建可以通过http://www.test.com/test.php
访问的脚本,内容如下:
function post($url, $param){
$oCurl = curl_init();
$aPOST = [];
foreach($param as $key=>$val){
$aPOST[] = $key.'='.urlencode($val);
}
$strPOST = join('&', $aPOST);
curl_setopt($oCurl, CURLOPT_URL, $url);
curl_setopt($oCurl, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt($oCurl, CURLOPT_POST,true);
curl_setopt($oCurl, CURLOPT_POSTFIELDS,$strPOST);
$sContent = curl_exec($oCurl);
$aStatus = curl_getinfo($oCurl);
curl_close($oCurl);
if(200 == intval($aStatus['http_code'])){
return $sContent;
}else{
return false;
}
}
$server = 'http://localhost:8000/oauth/access_token';
$params = [
'grant_type' => 'password',
'username' => 'admin@admin.com',
'password' => '123456',
'client_id' => 'shy7jf8fa93d59c45502c0ae8chj76s',
'client_secret' => 'bc7f6f8fa93d59c45502c0ae8c4a95d',
];
echo post($server, $params);
访问需要授权的接口
不带access_token访问
本文首发于公众号:programmer_cc,转载请注明出处。
Dingo Api 1.0在laravel5.2中的简单应用的更多相关文章
- oAuth2.0在laravel5.2中的简单应用
oAuth是一个关于授权的开放网络标准,目前的版本是2.0.laravel是php开发框架,目前最新稳定版本是5.5.授权在应用程序中有非常广泛的使用场景,本文将以laravel5.2为例来简单介绍o ...
- laravel Passport - 创建 REST API 用户认证以及Dingo/Api v2.0+Passport实现api认证
第一部分: 安装passport 使⽤ Composer 依赖包管理器安装 Passport : composer require laravel/passport 接下来,将 Passport 的服 ...
- laravel Passport - Dingo/Api v2.0+Passport 实现 api 认证
第一部分: 安装passport 使⽤ Composer 依赖包管理器安装 Passport : composer require laravel/passport 接下来,将 Passport 的服 ...
- How ASP.NET Web API 2.0 Works?[持续更新中…]
一.概述 RESTful Web API [Web标准篇]RESTful Web API [设计篇] 在一个空ASP.NET Web项目上创建一个ASP.NET Web API 2.0应用 二.路由 ...
- laravel5.5 dingo/api+jwt-auth
因为laravel5.5 具有发现包功能,只要包做了兼容laravel5.5就可以不用在config/app.php添加额外代码了. 集成dingo/api github:https://github ...
- dingo/API 最新版 V2.0 之安装讲解
我发现关于dingo/API V2.0的资料少之又少,应该也是发布时间不久的原因.下面,我就来给大家讲解(翻译)下官方的英文文档,如果有说的不对的地方,请指正.先附上,官网wiki地址https:// ...
- 第一节: dingo/API 最新版 V2.0 之安装讲解(连载)
我发现关于dingo/API V2.0的资料少之又少,应该也是发布时间不久的原因.下面,我就来给大家讲解(翻译)下官方的英文文档,如果有说的不对的地方,请指正.先附上,官网wiki地址https:// ...
- 用laravel dingo api插件库创建api的一些心得笔记
用laravel创建api是很多大型项目正在使用的方法,一般他们都是用dingo api插件库来开发自己的api.以下是ytkah用dingo api的一些心得,有需要的朋友可以关注一下 1.安装 因 ...
- 五分钟入门 Dingo API
基于 https://laravel-china.org/doc... 文档更简洁的描述Dingo,直戳重点,注重实践 Django-Book 概述 Dingo API帮助您轻松快速地构建自己的API ...
随机推荐
- IPython学习笔记(一)
开始看<利用python进行数据分析>这一本书,记录下学习的点滴,对于每一个小知识点记录得过于详细,但是好记性不如烂笔头,动动手还是记得比较深刻点. 1.Tab自动补齐 输入an后按Tab ...
- 【转】对H264进行RTP封包原理
1. 引言 H.264/AVC 是ITU-T 视频编码专家组(VCEG)和ISO/IEC 动态图像专家组(MPEG )联合组成的联合视频组(JVT)共同努力制订的新一代视频编码标准,它最大的优 ...
- java集合---迭代器iterator
一:ArraryList 最终继承超级接口Collection,Colection接口继承Iterator接口. public interface Collection<E> exten ...
- 【VSC】git+github/码云+VSCode
VSCode中使用git,参见. (零)Git安装 在初次使用时如果本地没有安装git会提示先安装git,然后重启vscode. (一)本地操作项目前提: 1)若本地没有git拉取下来的项目,用git ...
- ios开发UI篇--UILabel
概述 UILabel类实现了一个只读文本视图.你可以使用这个类来画一个或多个静态文本.UILabel类支持既简单又复杂的样式标签文本,还可以控制外观,比如标签是否使用了一个影子或者处于高亮状态等等. ...
- Objective-C(生命周期)
视图控制器生命周期 : 1)当一个视图控制器被创建,并在屏幕上显示的时候. 代码的执行顺序 1.alloc 创建对象,分配空间 2.init(initWithNibName) 初始化对象,初始化数据 ...
- vue中使用codemirror
https://blog.csdn.net/oumaharuki/article/details/79268498 别人的记载,写的很不错,还有下载的方法 以下是自己使用过的,做出来的例子: 做出来 ...
- 4.Operators-操作符(Dart中文文档)
Dart有如下操作符: Description Operator unary postfix expr++ expr-- () [] . ?. unary prefix -expr !expr ~ex ...
- docker save和docker export的区别
docker save保存的是镜像(image),docker export保存的是容器(container): docker load用来载入镜像包,docker import用来载入容器包,但两者 ...
- 关于SignalR连接数量问题的记录
在使用SignalR的项目测试时遇到了一个问题,开发环境用的是Win10的操作系统,在VS2017调试环境中运行项目,连接多个SignalR客户端是没有问题的,例如,三个用户在一个聊天室同时聊天.但是 ...