blear.express.res-api

1Introduction
2Example
3Static
4res.api([code], result, [message])
5Dependencies
6Reference

1Introduction

description：express 中间件：添加 res.api
author：ydr.me
create：未明确
update：未明确
github：https://github.com/blearjs/blear.node.template

2Example

var resApi = require('blear.express.res-api');
var express = require('express');

var app = express();

app.use(resApi(app));
app.get('/', function (req, res, next) {
    res.api(123);
});

访问“/”路径，响应的数据为

{
    code: 200,
    result: 123,
    message: null
}

3Static

3.1`.defaults`

类型：Object
说明：默认配置

3.2`.defaults.errorCode`

类型：Number
说明：错误代码
默认：500

3.3`.defaults.errorMessage`

类型：String
说明：错误消息
默认："网络错误"

3.4`.defaults.rewriteError`

类型：Boolean
说明：是否重写 Error
默认：false

4`res.api([code], result, [message])`

响应单个数据

res.api(true);
// {code: 200, result: true}

res.api(123);
// {code: 200, result: 123}

res.api({
    name: 123,
    age: 456
}});
// {code: 200, result: {name: 123, age: 456}}

res.api([
    123,
    456
]);
// {code: 200, result: [123, 456]}

响应单个错误

res.api(new Error('出错啦1'));
// {code: 500, message: "出错啦1"}

res.api(new TypeError('出错啦2'));
// {code: 500, message: "出错啦2"}

响应错误代码及消息

res.api(404, '该页面不存在');
// {code: 404, message: "该页面不存在"}

res.api(1000, '找不到该用户');
// {code: 1000, message: "找不到该用户"}

响应具体结果

res.api(1999, result: {a: 1}, message: "呵呵");
// {code: 1999, result: {a: 1}, message: "呵呵"}

4.1`code`

类型：Number
说明：代码类型
默认：200

4.2`result`

类型：*
说明：响应结果

4.3`message`

类型：String
说明：错误消息
默认：null

5Dependencies

6Reference

无。