README.zh_CN.md

egg-response

English|中文

依赖说明

依赖的 egg 版本

egg-response 版本	egg 1.x
1.x	😁
0.x	❌

安装

$ npm i egg-response
或者
$ yarn add egg-response

开启插件

// config/plugin.js
exports.response = {
  enable: true,
  package: 'egg-response',
};

使用场景

// {app_root}/app/controller/post.js

ctx.successful(data[,options]);

// 或者

ctx.failed([options]);

API

ctx.successful(data[,options])

创建一个成功的响应

参数

• data -响应返回的数据
• options(可选) -Object，有以下可选属性:
  • isData -boolean,是否返回数据，默认值为true,如果设置为false，返回的json字段data会被message替代
  • code -int，响应状态码，默认值为200
  • extra -Object，附加信息

示例

ctx.successful([1,2,3],{
  extra: {
    xxx: '追加的消息'
  }
});

• 返回结果，将会是json格式,如下:

{
  "code": 200,
  "success": true,
  "data": [1,2,3],
  "xxx": "追加的消息"
}

ctx.failed([options])

创建一个失败的响应

参数

• options(可选) -Object,有以下可选属性：
  • message -错误提示信息，默认值为'Request error'
  • code -响应状态码，默认值为500
  • extra -追加消息

示例

ctx.failed({ message:'没有该类目' });

• 返回结果，将会是json格式,如下:

{
  "code": 500,
  "success": false,
  "message": "没有该类目"
}

过时的(v1.1.0)

ctx.createSuccessResponse(data[,code])

和

ctx.createFailedResponse([message[,code]])

详细配置

请到 config/config.default.js 查看详细配置项说明。

提问交流

请到 egg issues 异步交流。

License

MIT