Laravel 开发 RESTful API 的一些心得

tinyq 发布于2019-06-28 18:29 / 849人阅读

摘要：最近用写了一段时间的，总结一下自己的心得吧。开发我们可以看到，有些网站用验证身份，有些用，当时我也纠结，然后看到一个不错的说法。异常异常算是一大手笔了，处理好异常，可以让你的代码优雅很多。

最近用 Laravel 写了一段时间的 API，总结一下自己的心得吧。

Start

API开发我们可以看到，有些网站用token验证身份，有些用OAuth2.0，当时我也纠结，然后看到一个不错的说法。大方面，会涉及到给别人用的使用OAuth，自己使用的用token就足够了

设计最初，最好在路由加个版本号，方便以后扩展

Route::prefix("v1")->group(function () {
    // more
});

如果前端想跨域，请使用这个很方便的包barryvdh/laravel-cors

一个简单的接口示例

验证

API 开发总会离不开验证，这里推荐使用jwt-auth，1.0 快要来了，新版本的文档也很清晰

刚用jwt-auth时有疑问，Laravel自带的token验证使用的是数据库api_token字段验证，而不见jwt-auth需要这个

然后想自己看源码，结果QAQ

最后去问了官方 >_<

原来用户的信息已经存储在token中加密

一开始有疑问，这样保存，不会被解密吗(真为自己智商担忧 !_!)

后来才想起，jwt一开始就运行php artisan jwt:secret生成了秘钥

你不泄露就保证安全了~~~

路由

当然使用官方api的路由Route::apiResource(),一条更比五条强

路由的名字当然是RESTful的方式

保持动词，复数形式，见名知义

有些长的路由，应该用什么分隔呢？

laravel用的是中划线(-)，因为谷歌收录时，按中划线划分关键字，国内的是按下划线(_)收录，具体看自己了，我是喜欢下划线 >_<

更多看这里：路由命名规范

表单验证

可以使用控制器自带的表单验证，更推荐使用表单类,能分离都分离出去，控制器不要处理太多事情。

能分离的代码都不要吝啬~~~

数据转换

Laravel自带的API Resource

用起来真的很方便，不过发现一个问题，--collection的格式总是转不过来，后来直接放弃了

单个的使用Resources

集合的使用Resources::collection()发现，特别好用 >_<

不得不说，多对多关联时，Laravel处理得太好了条件关联

在上面这个例子中，如果关联没有被加载，则 posts 键将会在资源响应被发送给客户端之前被删除。

在有不确定是否输出关联数据时，这是一个很有用的功能！！！

响应输出

当时在 laravel-china 看到的这个帖子，然后觉得这个方式不错，所以自己也这样子，使用基类的方法统一响应输出。

异常

异常算是一大手笔了，处理好异常，可以让你的代码优雅很多。
AppExceptionsHandler::render方法可以捕获到很多有用的异常，例如，我的代码是这样写的：

UnauthorizedHttpException这个是捕获jwt异常
ValidationException这个是表单异常，捕获之后，表单错误消息可以很好的格式化，
ModelNotFoundException这个是模型找不到的异常，捕获之后，可以直接在控制器直接这样

// 未捕获之前的写法
public function show($id)
{
    $user = User::find($id);
    if (! $user) {
        
    }
    
    // do something
}

// 现在
public function show($id)
{
    $user = User::findOrFail($id);
}
// 甚至这样
public function show(User $user)
{
    // do something
}

下面这两个异常可以不捕获，只是方便开发中查看错误消息

NotFoundHttpException404路由找不到的异常，没什么好说的了
MethodNotAllowedHttpException这个是方法不对应，比如你是get路由，却post请求

文档

差点忘了这个，文档非常非常重要

我是不怎么喜欢在注释写文档的

使用swagger-ui+swagger-edit

下载swagger-ui

只需要dist目录的东西（其他可以删除了）

下载swagger-editor

只要dist目录的东西和根目录的index.html

我还把swagger-editor的index.html改成了edit.html，然后把这两个东西整合到同一个目录（记得修改css,js的位置）

新建两个文件api.json,api.yaml 大概就和图中差不多

要修改图中箭头所示成为api.json的位置

访问edit.html可以书写文档

编写语法

访问index.html可以查看文档

在edit.html写好之后，导出json，然后粘贴到api.json文件

记得也把写好的格式保存到api.yaml，因为清楚缓存之后，下次访问时会消失

自己写了一个packages

就方便创建控制器，验证

所有控制器继承重写过的基类，响应输出方便。

例如完整验证只需要三秒钟

第一秒: php artisan api:auth

第二秒: 出现图代表成功;

* 第三秒: 拿出手臂的劳力士，确定只过了三秒

更多的使用：laravel-api-helper

工作和API开发有关，用到其他有经验了再回来补补。

更多参考

RESTful API 设计指南

idc机房托管超融合服务器 restful_api返回 java一些开发工具 laravel5框架开发 php开发api接口的实例代码

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/28325.html

PHP / Laravel API 开发推荐阅读清单

showImg(https://segmentfault.com/img/bV6aHV?w=1280&h=800); 社区优秀文章 Laravel 5.5+passport 放弃 dingo 开发 API 实战，让 API 开发更省心 - 自造车轮。 API 文档神器 Swagger 介绍及在 PHP 项目中使用 - API 文档撰写方案推荐 Laravel API 项目必须使用的 8 个...

shmily 2019-06-28 18:34 评论0 收藏0
关于JWT(Json Web Token)的思考及使用心得

摘要：什么是是一个开放的数据交换验证标准，一般用来做轻量级的鉴权。由于许多接口设计是遵循无状态的比如，所以是这一套机制的替代方案。组成由三部分组成头部载荷签名。什么是JWT？ JWT(Json Web Token)是一个开放的数据交换验证标准rfc7519(https://tools.ietf.org/html/r...，一般用来做轻量级的API鉴权。由于许多API接口设计是遵循无状态的(...

taohonghui 2019-07-01 10:47 评论0 收藏0
PHP相关

摘要：的机器学习库的机器学习库，包括算法交叉验证神经网络等内容。在即将到来的大会上，她将和大家分享在机器学习领域的全新可能。入门总结入门相关，如安装配置基本使用等。基于 Swoole 开发 PHP 扩展 Swoole-1.9.7 增加了一个新特性，可以基于 Swoole 使用 C++ 语言开发扩展模块，在扩展模块中可以注册 PHP 内置函数和类。现在可以基于 Swoole 来编写 PHP ...

lewinlee 2019-06-28 14:39 评论0 收藏0
后端API从入门到放弃指北

摘要：菜鸟教程框架中文手册入门目标使用搭建通过对数据增删查改没了纯粹占行用的拜后端API入门学习指北了解一下一下概念. RESTful API标准] 所有的API都遵循[RESTful API标准]. 建议大家都简单了解一下HTTP协议和RESTful API相关资料. 阮一峰:理解RESTful架构阮一峰:RESTful API 设计指南 RESTful API指南依赖注入 D...

Jeffrrey 2019-08-16 12:31 评论0 收藏0
后端API从入门到放弃指北

摘要：菜鸟教程框架中文手册入门目标使用搭建通过对数据增删查改没了纯粹占行用的拜后端API入门学习指北了解一下一下概念. RESTful API标准] 所有的API都遵循[RESTful API标准]. 建议大家都简单了解一下HTTP协议和RESTful API相关资料. 阮一峰:理解RESTful架构阮一峰:RESTful API 设计指南 RESTful API指南依赖注入 D...

sf190404 2019-07-30 16:53 评论0 收藏0