有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
注意
API 管理的独立环境与应用集成环境不互通。
各大企业每天都有大量的 API 增长,同时越来越多公司开始公开 Web API,API 的使用场景正在累积。现在,每日 API 调用量在不断飙升,如何能够安全有效将这些 API 管理起来对于企业而言并不容易。
腾讯云数据连接器提供 API 发布功能,可以一键将已发布的应用打包生成 API,方便用户进行管理和调用;同时提供了 API 管理能力,可以针对 API 进行访问权限管控和流量调度。

API 管理主页

登录 腾讯云数据连接器控制台,在左侧导航栏单击 API 中心 > API 管理,即可进入 API 管理的主页。
在 API 管理主页,您可以创建或查看 API,API 列表中展示有 API 服务名称、API 服务状态、API 服务域名、API 更新时间、API 服务的数据统计、endpoint 统计、API 服务的鉴权方式以及操作等内容。同时,每个API服务均可展开,查看下属的 endpoint 的信息和状态。



创建 API 服务

API 管理功能支持 3.0.0 版本的 OpenAPI 规范。OpenAPI 3.0.0 规范的对象定义请参见 OpenAPI Specification。用户可以通过单击创建 API 服务进入 API 创建界面。
创建 API 服务可以通过 API 描述文件创建,也可以通过页面手动创建。
通过 API 描述文件创建
通过页面手动创建
1. API 管理 页面,单击创建 API 服务,在基本配置中配置以下信息,完成后单击下一步:策略信息
创建方式:选择创建自配置文件
上传描述文件:上传 YAML 或 JSON 格式的文件,大小100KB以内
支持格式:YAML、JSON


2. 若解析成功,单击完成,则可以直接通过此文件生成对应的 API 服务。
1. API 管理 页面,单击创建 API 服务,在基本配置中配置以下信息,完成后单击下一步:策略信息
创建方式:选择“手动创建”
API名称:请输入 API 名称
协议:支持 HTTP、HTTPS、HTTP 和 HTTPS 协议类型
版本:请输入版本号
描述(选填):对此 API服 务的一些简单描述
标签(选填):如果有分组的需要,希望日后可以通过标签来进行快速的 API 服务筛选工作,还可以配置标签信息


2. 在策略信息中配置以下信息,单击完成即可创建一个 API 服务。
配置鉴权策略:支持 BasicAuth、OAuth2.0 和无验证(即不填写检测策略)
配置黑白名单:您可以按需开启,开启后可以输入多条 IP 进行黑白名单的访问限制
开启访问限制:
请求频率策略:从配置时间起,每单位时间内允许的最大请求次数,填写范围为1 - 1000
访问限制策略:从配置时间算起,每单位自然时间内允许的最大访问次数,填写范围为1 - 1000




创建 API Endpoint

当我们创建好一个 API 服务之后,则代表此 API 已经生成,可以开始编辑其具体行为。 API Endpoint 指一个 API 服务可以连接的后端服务信息,包括 API 的访问路径(API Path)、API 的调用方式、分组、API Endpoint 绑定的后端服务类型,最近修改时间以及一些操作。


默认新创建好的 API 服务是没有已绑定的 Endpoint 信息的,需要进行创建完成首次的绑定工作。
1. API 管理 页面,单击目标 API 服务名称,进入服务详情页。
2. 单击添加 API Endpoint,进行 API Endpoint 基本配置,完成后单击下一步:策略信息
访问路径:访问路径必须要以“/”开头。
后端服务:支持选择现成的集成流或者绑定第三方服务 BASE URL。
当选择的后端服务为“集成流”模式时,集成流只可以选择已发布的,并且配置了拥有 HTTP 监听能力组件的流。
当选择“第三方服务 BASE URL”时,在资源路径处输入资源链接。
描述:选填。



3. 在策略信息页面,配置以下信息,完成后单击下一步:参数信息
说明
与 API 服务的策略信息配置方式类似,允许用户在此 Endpoint 所归属的 API 服务的策略限制基础上,配置第二层策略限制。两层限制共同生效。
配置鉴权策略:您可以单击“同步服务策略”,一键同步上层的API服务策略,或者手动填写新的管理策略。 此处可选择的鉴权策略范围为上层 API 服务的鉴权策略,即若上层 API 服务只允许 OAuth 2.0 的鉴权方式,则下层的 API Endpoint 只允许配置 OAuth 2.0,而不能配置 Basic Auth。



4. 在参数信息页面,您可以配置访问此 API Endpoint 时可以选用的方法(API Method)和每种方法对应的调用参数信息。
API 调用方法可以多选,若想取消,则可以反选想要删除的方法。
每一个参数后都提供了一系列操作,分别为:向上移动、向下移动、删除此参数,为此参数添加备注以及选择该参数是否必填。


5. 当上述配置全部完成后,单击完成,则会返回 API 列表,同时已经创建好的 Endpoint 信息将会展现在此。

API 测试与运维

腾讯云数据连接器 API 管理平台同时还提供了完整的运维方案。查看步骤如下:
1. API 管理 页面,找到目标 API 服务,单击操作列的数据统计图标,进入运维页面。


2. 在运维页面,您可以查看此 API 在规定时间范围内的请求记录和状态汇总。


同时,为了方便用户对配置完成的 API 进行在线的调试,我们还提供了通过控制台实时发送测试请求并且获取模拟测试结果的机制。操作步骤如下:
1. API 管理 页面,单击目标 API 服务名称前面的

,显示访问路径。
2. 在访问路径中,单击操作列的调试,进入 API 调试页面。


3. 在 API 调试页面,您可以配置此 API Endpoint 的请求 Header 和 Body 内容,并单击发送请求

随后即可获取到测试的结果。我们会将后端服务返回的 Response 状态码和结果返回给用户,方便进行进一步的调试工作。