基类控制器里有`error`方法,用于`api`的错误消息返回输出
```
/**
* 操作错误跳转的快捷方法
* @access protected
* @param mixed $msg 提示信息,若要指定错误码,可以传数组,格式为['code'=>您的错误码,'msg'=>'您的错误消息']
* @param mixed $data 返回的数据
* @param array $header 发送的Header信息
* @return void
*/
protected function error($msg = '', $data = '', array $header = [])
```
有几种用法如下:
## 只输出错误消息
```
$this->error('操作失败!');
```
返回结果:
```
{
"code":0,
"msg":"操作失败!",
"data":""
}
```
## 携带数据
```
$this->error('操作失败!',['title'=>'文章标题']);
```
返回结果
```
{
"code":0,
"msg":"操作失败!",
"data":{
"title":"文章标题"
}
}
```
> 第二个参数`$data`,支持多种格式,可以是int,float,string,array 等
## 自己携带额外header 数据
```
$this->error('操作失败!',['title'=>'文章标题'],['XX-Author'=>'Catman']);
```
返回结果:
```
{
"code":0,
"msg":"操作失败!",
"data":{
"title":"文章标题"
}
}
```
但 response header里会增加额外数据:
![](https://box.kancloud.cn/af213ea895ddebd13524b0fd20051022_1806x884.png)
## 指定错误码
```
$this->error(['code'=>10002,'msg'=>'您的错误消息'],['title'=>'文章标题'],['XX-Author'=>'Catman']);
```
返回结果:
```
{
"code":10002,
"msg":"您的错误消息",
"data":{
"title":"文章标题"
}
}
```
- 介绍
- 环境配置
- 规范
- 状态码说明
- 参数规范草案
- 版本号
- 控制器
- 资源控制器模板
- 成功返回
- 错误返回
- 路由
- 应用
- 基类控制器
- 应用开发流程
- API
- 用户
- 发送邮箱或手机验证码
- 用户注册
- 用户登录
- 文件上传
- 密码修改
- 密码重置
- 用户退出
- 用户手机号绑定
- 用户邮箱绑定
- 用户信息获取
- 用户信息修改
- 余额记录(未发布)
- 积分记录(未发布)
- 余额转账(未发布)
- 小程序
- 用户登录
- 评论
- 评论列表
- 我的评论列表
- 添加评论
- 删除评论
- 门户应用
- 文章
- 文章列表
- 文章列表
- 分类文章列表
- 推荐文章列表
- 会员文章列表
- 会员添加文章
- 会员编辑文章
- 会员删除文章
- 获取文章
- 我的文章列表
- 文章搜索
- 文章点赞
- 取消文章点赞
- 文章收藏
- 取消文章收藏
- 分类
- 分类列表
- 获取分类
- 子分类列表
- 页面
- 页面列表
- 获取页面
- 标签
- 热门标签列表
- 标签文章列表
- 幻灯片获取
- 收藏
- 我的收藏列表
- 添加收藏
- 取消收藏
- 判断是否已收藏
- 后台
- 管理员登录
- 管理员退出
- 模板
- 扩展属性
- 小程序开发
- 版本发布
- 小程序模板下载
- 演示代码安装
- 新建页面
- API 请求
- 附录
- 升级日志
- 升级指导