提供基于RestFul的生成接口数据的便捷方法
$ npm install --save koa2-api
const api = require('koa2-api')
app.use(api())
定义了一个api属性挂载到了koa的ctx上,可以再控制器或路由直接取到ctx进行使用
ctx.body = { id: 1 }
改为
ctx.api.success({ id: 1 })
成功响应,状态码默认200, 可通过 code
参数改变
错误响应,状态码默认404, 可通过 code
参数改变
资源已创建的响应,状态码默认201,可传入 localtion
参数,标识资源位置,将会在响应头中添加 Location
属性
资源已更新的成功响应,状态码默认200
资源已删除的成功响应,状态码默认200
无内容响应,状态码204
请求不合法错误, 状态码为400
未认证错误, 状态码为401
服务器拒绝错误, 状态码为403
没有找到资源的错误, 状态码为404
方法不允许的错误, 状态码为405
无法接受的类型, 状态码为406
服务当前无法处理请求错误, 状态码为503
以 key-value 的方式向响应数据的meta属性中添加属性
设置响应数据的meta属性
向响应头添加header属性
以上属性支持链式调用:
ctx.api.addMeta('name', 'zewail').success({ id: 1 })