apinit v0.0.1

apiio

一款实用的处理Serverless架构API网关触发器的工具，让你轻松处理请求和发送响应，可跨平台使用。

优点

• 完美支持Serverless服务的API网关触发器的相关事件，简单易用

• 相比原生写法，使用apiio后，能够大大减少开发工作量

• 兼容从Koa框架迁移Serverless服务，只需要改动几行代码就可以适配

支持平台

目前appio已支持以下云计算平台的Serverless服务：

安装

使用npm安装：

npm install apiio

如果访问速度较慢，建议使用cnpm安装：

cnpm install apiio

使用

引用

使用前，首先进行引用：

const Apiio = require('apiio')

初始化

方式一（推荐）

直接使用解构语法获取 request 和 response 对象：

const { request, response } = new Apiio(event, context, callback)

同时也支持以下别名方式（建议使用别名，更简短）：

const { req, res } = new Apiio(event, context, callback)

方式二

直接获取app对象，以属性的方式使用 request 和 response 对象：

const app = new Apiio(event, context, callback)
app.request    // request对象
app.response   // response对象

同理，方式二也支持 req 和 res 别名。

const app = new Apiio(event, context, callback)
app.req    // request对象
app.res    // response对象

使用方式

你可以像使用普通对象那样使用 request 对象和 response 对象，例如可以使用 request.method 获取请求方法，使用 response.body='abc' 设置响应主体，等等。最终使用 response.send() 发送响应。

request.method         // 获取请求方法
response.body='abc'    // 设置响应主体为abc
response.send()        // 发送响应

完整的属性和方法请查看以下的请求对象（request）和响应对象（response）。

请求对象（request）

属性

request 对象用于接收API网关的入参。包含以下参数：

以下属性不常用，但也提供了支持：

以下属性不建议使用，可用于调试：

方法

别名支持

考虑到部分开发者的使用习惯，同时支持以下别名，使用别名和参数名具有完全一致的效果，您无须考虑使用别名引起的兼容性问题。

属性别名：

方法别名：

响应对象（response）

属性

方法

设置响应状态码

可以通过以下2种方式设置响应的状态码，如果您未指定状态码，将默认设定为 200 。

方式一：使用 setCode 方法设置响应的状态码（推荐）

response.setCode(200)

方式二：直接对 statusCode 赋值设置响应的状态码

response.statusCode = 200

设置响应状态消息

可以通过以下2种方式设置响应的状态消息，如果您未指定状态消息，将自动按照HTTP协议规范自动填充。

方式一：使用 setMessage 方法设置响应的状态消息（推荐）

response.setMessage('ok')

方式二：直接对 statusMessage 赋值设置响应的状态消息

response.statusMessage = 'ok'

设置响应头

设置响应body

发送响应

使用 send 方法发送响应，------

别名支持

同样考虑到部分开发者的使用习惯，同时支持以下别名，使用别名和参数名具有完全一致的效果，您无须考虑使用别名引起的兼容性问题。

API网关配置

阿里云

使用演示

版本历史