快速入门(开放API)

使用概览

本文快速指导您如何创建并开放API。

创建并开放API服务步骤:

  1. 创建API分组

  2. 绑定域名

  3. 创建API

  4. 调试API

  5. 开放API

创建API分组

API分组是同一种业务API的集合,创建API前,需要先创建API分组。

创建API分组步骤:

  1. 在创建分组前,先选定region,选定后不能修改。

  2. 创建分组,输入“分组名称”、“描述”。

  3. 创建分组后,API网关会自动分配给该分组一个唯一的三级域名,您可访问该三级域名测试该分组下的API,每天有1000次访问限制。

详细创建步骤,请参考【操作指南(开放API)】-【API分组】-【创建API分组】

绑定域名

如要开放API服务,需要您为分组绑定独立域名,独立域名需备案且cname到该分组三级域名下,先解析,后绑定。如果API要支持https协议,则需要为该独立域名上传SSL证书,此证书不支持导入,您需要填写证书和密钥。

API 网关通过域名来定位到一个唯一的 API 分组,再通过Path+HTTPMethod 定位唯一的 API。详细创建步骤,请参考【操作指南(开放API)】-【API分组】-【绑定域名】

创建API

创建完成API分组后,即可创建API,请按照如下流程创建。

选择创建的API类型,RESTful API或AWS风格API

定义API请求:分组、API 名称、认证方式、请求协议、请求方法、路径、描述、API 请求参数定义、请求Body定义、请求示例。

定义后端配置:后端协议类型、后端请求方法、后端地址、后端路径、后端超时时间、后端参数映射、后端常量参数、Body映射。

定义返回结果:错误码定义、最终响应Header、最终响应Body示例、后端响应Header映射、后端响应Body映射,详细创步骤,请参考【操作指南(开放API)】-【API管理】-【创建RESTfulAPI】

调试API

创建成功API后,需要对API进行调试,验证服务是否正常,调试成功后才可正式开放API。

首先您需要把API发布到测试环境或者线上环境,然后可在线调试API,测试API运行是否正常,调试成功后可通过客户端调用API。

开放API

完成API调试确认API运行正常后,就可把API发布至线上环境开放API,API只有在发布到环境(测试环境、生产环境)后,才支持被调用。

对外开放的 API,应在所属分组上绑定独立域名,三级域名仅供测试使用,直接访问三级域名有流控限制为1000次/天。