更新时间:2022-03-18 GMT+08:00
分享

通过Explorer调试API

“Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。

前提条件

应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数

操作步骤。

  1. 登录ROMA API控制台。
  2. 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
  1. 在左侧导航栏选择“API消费 > API目录”。
  2. 单击产品名称
  3. 单击“Explorer”页签,选择版本号进入。

    页面的最左侧展示产品下的API,中间可配置API请求参数,最右侧支持查看调试结果和API文档。

  4. (可选)单击“文档”页签,查看API文档信息。
  5. 根据已设置认证方式,编辑请求参数,单击“调试”。

    表1 请求参数说明

    认证方式

    Headers

    Parameters

    Body

    APP认证

    说明:

    APP认证凭证:选择已创建凭证,可选择的凭证是已使用凭证订阅了API所在产品的凭证。

    填写API的Headers参数。

    填写API的Params参数。

    • 已定义Body

      通过切换输入方式可以选择表单填写或文本输入请求体。

    • 未定义Body

      通过POST/PUT/PATCH方法请求的API支持展示自定义填写。

      说明:

      如果API已定义formData类型参数,将不展示Body参数,且暂不支持调试。

    IAM认证

    支持Token认证或AK/SK认证。Explorer自动获取或临时生成Token或AK/SK。

    无认证

    填写API的Headers参数。

    自定义认证

  6. 单击“调试结果”页签,查看调试结果。
分享:

    相关文档

    相关产品