调试API

概述

在API创建后，您可以使用ROMA Connect提供的调试功能对API进行调试，确保API的功能正常。

前提条件

• 后端服务请求路径中含有环境变量的API不支持调试。
• 在调试API时，API绑定流控策略无效。
• 若定义API后端服务时配置的“后端超时(ms)”与“重试次数”相乘的值大于30秒，则调试API会超时。

操作步骤

1. 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。
2. 在左侧的导航栏选择“服务集成 APIC > API管理”，在“API列表”页签中单击API右侧的“更多 > 调试”。
3. 在调试页面中，左侧为API请求参数配置区域，根据API的定义配置API的请求信息。

   表1 请求参数配置

   参数	配置说明
   Protocol	仅当API的请求协议为“HTTP&HTTPS”时，支持选择请求协议。
   Method	仅当API的请求方法为“ANY”时，支持选择请求方法。
   Path	仅当API请求路径的匹配模式为“前缀匹配”时，支持为请求路径添加自定义后缀（Suffix）。
   Path Parameters	仅当API的请求路径包含Path参数时，支持配置Path参数。
   Query Parameters	根据API的定义添加和配置Query参数。
   Header Parameters	根据API的定义添加和配置Header参数。
   Body	仅当“Method”为“POST”、“PUT”或“PATCH”时，支持配置Body参数。

4. 完成请求参数配置后，单击“发送请求”，页面右侧显示调用API发送的请求信息和接收的响应信息。
   • 调用成功时，API响应中返回“200”状态码和正常响应消息体。
   • 调用失败时，API响应中返回“4xx”或“5xx”状态码和错误码，具体错误信息请参见附录：API错误码。

   您可以通过调整请求参数与参数值，发送不同的请求，验证API功能。