首页 >API 网关 >创建API >创建 API

创建 API

创建API即录入API的定义,需要录入API的基本信息、服务信息、请求信息、和返回信息,然后对创建的API进行调试,及进行安全配置。经测试证明API可用后,可发布上线供用户使用。

1 定义 API

在API网关控制台中API列表页面,单击创建API,即进入API的创建和定义流程。

1.1 定义请求的基本信息

参数

描述

API分组

分组是API的管理单元,创建API之前您需要先创建分组,选择分组即选择Region。

API名称

所创建的API的名称。API名称标识需在所属分组内具有唯一性。

安全认证方式

目前支持阿里云APP、OpenID Connect、OpenID Connect&阿里云APP和无认证四种认证方式。

  • 阿里云APP:要求请求者调用该API时,需通过对APP的身份认证。

  • OpenID Connect:是一套基于OAuth 2.0协议的轻量级规范,提供通过RESTful APIs进行身份交互的框架。可以使用OpenID Connect和您的自有账号系统无缝对接。详细介绍请参见API 网关 OpenID Connect 使用指南。(仅经典网络实例可用)

  • - OpenID Connect & 阿里云APP:同时进行OpenID Connect和阿里云APP认证。(仅经典网络实例可用)

  • 无认证:即任何人知晓该API的请求定义后,均可发起请求,网关不对其做身份验证,均会将请求转发至您的后端服务。(强烈不建议使用此模式。)

签名算法

参与签名的算法

  • HmacSHA256

  • HmacSHA1和HmacSHA256:表示同时支持这2种签名算法。

描述

填写API的相关描述。

1.2 定义API请求

定义用户如何请求API,包括协议、请求Path、HTTP Method、入参请求模式、和入参定义。

参数

描述

请求类型

请求类型: 有4种类型可选。

普通请求:普通的HTTP(S)协议请求。

注册请求(双向通信):是双向通信的管理信令,是客户端发送给服务端,注册设备使用。

注销请求(双向通信):是双向通信的管理信令,是客户端发送给服务端,注销设备,注销成功后,将不再接受服务端推送的下行通知。

下行通知请求(双向通信):用户后端服务,在收到客户端发送的注册信令后,记住注册信令中的设备ID字段,然后就可以向API网关发送接收方为这个设备的下行通知信令了。只要这个设备在线,API网关就可以将此下行通知发送到端。

请求协议

支持HTTP、HTTPS、WEBSOCKET。

请求Path

Path指相对于服务host,API的请求路径。请求Path可以与后端服务实际Path不同,您可以随意撰写合法的有明确语义的Path给用户使用。您可以在请求Path中配置动态参数,即要求用户在Path中传入参数,同时您的后端又可以不在Path中接收,可以映射为在Query、Header等位置接收。

HTTP Method

支持标准的HTTP Method,可选择PUT、GET、POST、DELETE、PATCH、HEAD、OPTIONS或ANY。

入参定义模式

可选入参映射(过滤未知参数)、入参映射(透传未知参数)和入参透传。

  • 入参映射(过滤未知参数):表示Query,Path 和 Body Form位置的参数需要配置前后端映射,网关只会透传给后端配置过的参数,其他参数会被过滤掉。

  • 入参映射(透传未知参数):表示Query,Path 和 Body Form位置的参数需要配置前后端映射,网关除配置的请求参数外,不对其他位置的请求参数进行映射与校验,用户参数会透明传递给后端。

  • 入参透传:表示不需要在入参定义处配置Query,Body Form参数(PATH参数仍需要配置)。客户端传给网关的参数都会被网关透传给后端

配置入参定义:定义您API的请求入参,即配置用户需要在什么位置传入什么参数。可选位置有Head、Query、Body、Path(Parameter Path),尤其当您在Path中配置了动态参数,那么在入参配置时需要对动态参数做配置说明。支持的参数类型有String、Integer、Boole