API 网关

产品文档

API 网关

帮助中心 > 产品文档 > API 网关 > 使用Function函数构建API

使用Function函数做为API后端服务

目前,API网关可以使用Function函数做为后端服务。对于选择函数计算为后端服务的API,当有请求到达网关时,API网关会触发函数的执行;函数收到请求后,会将执行结果再返回给API网关。以下,将通过示例对API网关触发函数计算的使用步骤进行详细介绍。

操作步骤

第1步: 在Function函数中创建函数

第2步: 创建API分组,创建分组下的API

创建API分组

  1. 登录 API网关 控制台

  2. 在“API分组管理”页面,点击 新建API分组 ,进入“创建”页面。

  3. 填写分组信息后,点击确定,即新建分组。当首次新建时,系统会自动将其保存为版本号为0.0.1的版本。后续可在版本管理中进行多版本维护。

创建分组下的API

API 分组创建完成您就可以创建 API 了,创建 API 是定义 API 请求的过程。您需要在创建中依次定义以下内容:

  • API 的基本信息:地域、API 名称、子路径、描述等。

  • API 请求:查询参数、请求体类型、请求体格式、响应体类型、响应体格式等。

  • API 后端:选择Function为后端服务

第3步: 发布API分组到环境上

API分组管理页,通过 发布操作,将API分组发布到环境。

发布过程中,可选择需要发布的环境(测试、预发、线上),选择要发布的版本,配置后端地址,然后点击发布,即可将分组发布到环境中。

第4步: 给API调用者授权访问

  • 授权访问

当API提供者通过授权访问方式提供API调用时,API调用者需要先创建一个用于调用API的访问密钥,并将密钥提供给API提供者进行分组的授权绑定。之后API调用者才能使用下载的SDK包。

  • 免鉴权访问

当API提供者通过免鉴权方式提供API调用时,API调用者可直接通过下载的SDK进行访问。

第5步: API调用者下载和使用SDK包,进行函数调用

更新时间:2020-02-13 18:34:02