is-message
v1.0.2
Published
一个简单的nodejs消息体模块, 你可以安装它以建立更统一更便于阅读和维护的接口服务器
Downloads
4
Readme
is-message
一个简单的nodejs消息体模块, 你可以安装它以建立更统一更便于阅读和维护的接口服务器
安装教程
- 使用
npm install --save is-message在项目中安装依赖. - 在代码中使用引用这个依赖, 看上去他的样子应该类似于这样的
const message = require("is-message"); - 在需要使用的地方使用
new message()的方式建立一个新的消息体. 然后即可使用相关API(方法)
相关API
- setStatus(status) --- 设置状态码, 必填项, 最基本的前端判断依据, 推荐使用HTTP的错误代码, 比如 200=请求成功;400=无效请求;403=缺少参数...等等
- setMessage(message) --- 设置消息内容, 建议作为必填项联合状态码使用, 比如"登陆成功","用户名不存在"..等等
- setData(data) --- 附加数据, 可空, 可以接任意数据, 比如 Object/Array/String/Number..主要场景在比如获取用户信息里, 用户信息数据存在这个里面
- setAccessToken(access_token) --- JWT模式, 设置access_token (1.0.2)
- setRefreshToken(refresh_token) --- JWT模式, 设置refresh_token (1.0.2)
完整参考
const message = require("is-message");
const msg1 = new message();
const msg2 = new message();
// 支持jQuery的那种链式写法, 让大家上手更亲切
msg1.setStatus(200).setMessage("获取用户信息成功").setData({name:"黄俊杰",sex:"男"});
// msg2效果和msg1一直, 仅仅是写法的问题
msg2.setStatus(200);
msg2.setMessage("获取用户信息成功");
msg2.setData({name:"黄俊杰",sex:"男"});