php 接口编写规范文档,php接口编写规范

1.建议把错误信息写到一个配置文件里面。

类似于下面这种：return [

//通用模块 错误信息 10

'COMMON' => [

'PARAMS_REQUIRED' => [

'code' => '10001',

'message' => '缺少必要参数',

],

'PARAMS_INVALID' => [

'code' => '10002',

'message' => ':attribute不在有效范围',

]

],

];

2.请求成功返回的方法：请求方式：return $this->success();

/**

* API请求结果为成功后返回调用

*

* @param $data 返回内容

* @return mixed

*/

public function success($data = [])

{

$result = ['status' => 'ok'];

if (!empty($data)) {

$result['data'] = $data;

}

return $this->response->array($result);

}

3.请求错误返回的方法：请求方式：return $this->error('COMMON.DB_ERROR');

/**

* API请求结果为成功后返回调用

*

* @param $data 返回内容

* @return mixed

*/

public function error ($data = [])

{

$result = ['status' => 'error'];

然后根据错误码找到错误的信息提示。如果错误信息没在配置文件里，可以返回个固定的。比如系统错误之类的。

$aError['data'] = $data['data'];

$aError['msg'] = $data['msg'];

$result['error'] = $aError;

return $this->response->array($result);

}