PhalApi v2.16.0 版本更新内容
1、新增接口
@method
注释,可以限制接口请求方式为GET或POST或其他,同步修改接口文档列表页、接口文档详情页。
请求方式
HTTP/HTTPS协议的请求方式有以下8种方式:
GET
HEAD
POST
PUT
DELETE
CONNECT
OPTIONS
TRACE
如果需要指定API请求的方式,例如只允许GET请求或只允许POST请求,或者允许多种请求方式,可以在接口方法的注释中使用@method
注释。
例如:
<?php
namespace App\Api\Examples;
use PhalApi\Api;
class CURD extends Api {
/**
* 更新数据
* @desc 根据ID更新数据库中的一条纪录数据
* @method POST
* @return int code 更新的结果,1表示成功,0表示无更新,false表示失败
*/
public function update() {
}
}
上面通过@method POST
指定了当前接口,只允许POST请求。
添加注释后,在接口文档列表页,会显示请求方式为POST。如果请求方式为空,则表示无限制。
在接口文档详情页,也会标注为POST方式。
如果使用GET方式请求此接口,会提示请求错误,例如接口返回:
{
"ret": 404,
"data": {},
"msg": "非法请求:请求方式错误,仅支持:POST"
}
温馨提示:
@method
需要PhalApi 2.16.0及以上版本支持。如果需要允许指定的多种方式,可以使用空格隔开,例如:@method POST GET
。
本文分享自微信公众号 - 小白开放平台(yesapi)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。