使用 云 Gem 门户 REST 探索者 - Lumberyard 用户指南

如果我们为英文版本指南提供翻译,那么如果存在任何冲突,将以英文版本指南为准。在提供翻译时使用机器翻译。

使用 云 Gem 门户 REST 探索者

Cloud Gem Portal (CGP) 已弃用,并将从未来的 Lumberyard 版本中删除。

在其环境中定义有服务URL的云例会进行测试,并且 故障排除 REST资源管理器 标签 云 Gem 门户 第页。的 REST 探索者 选项卡从导出服务API Amazon API Gateway 主人 json文件。

REST资源管理器 您可以执行以下任务:

  • 查询云珍的服务API,并对API端点进行测试调用。

  • 发现云环节的路径、路径的HTTPS动词以及 每个路径和动词组合。

  • 确定每个路径和动词组合的必需和可选参数。

  • 以JJNS格式查看swagger和swagger路径API定义。

  • 直接链接至 API 网关 用于进一步测试和故障排除的控制台。

Prerequisites

本教程假设以下内容:

开场白 REST资源管理器

本教程使用“今日消息”云珍宝,但您可以应用相同的技巧 任何拥有 REST资源管理器 选项卡。

打开REST资源管理器

  1. 云现场门户,在 云石 页面,选择 当日消息.

  2. 点击 REST资源管理器 选项卡。

    
            点击 REST资源管理器 选项卡 云 Gem 门户.

    初始 REST资源管理器 字段如下:

    • 主人 – API网关宿主的名称。

    • 标题 – 中的云珍服务API名称 API 网关.

    • 版本 – 服务API版本。

    • 方案 – 支持的服务API方案。

    • 路径 – 列出 云石。

    • 显示触发 – 以JNJ显示API定义 格式。

    • 发送 – 将请求发送给 API 网关 终点 已指定路径、动词和所需参数。

路径是 API 网关 主持人。每个云珍都有可用于 检索、创建或更新云珍功能的信息。每 路径具有一个或多个指定要对端点执行的操作的HTTPS动词。这些动词通常是 GET 检索, POST 创建, PUT 更新,以及 DELETE 删除数据。并非所有途径 支持所有动词。

REST资源管理器 首先选择路径,然后是 动词。在以下程序中,您将发布当天的测试信息。

选择路径和动词

  1. 对于 路径,点击 选择,然后选择 /admin/消息.

    
                在 REST资源管理器 选项卡
                  云 Gem 门户.
  2. 在您为以下项选择值后 路径, 言语 字段出现。点击 选择 了解 可用于路径的请求方法。要发布信息,请选择 发布.

    
                在 REST资源管理器 选项卡
                  云 Gem 门户.

    针对您指定路径和动词将采取的行动描述 组合出现在动词下方。

    
                拟采取的措施描述
  3. 要查看路径和动词的网格定义,请点击 显示路径 惊人. swagger代码定义了将采取的操作(在此 例如,将消息发布到消息表。)

    
                在 REST资源管理器 选项卡
                  的 云 Gem 门户.
  4. 点击 隐藏路径触发 关上 定义。

选择路径和动词后,输入所需参数的值。显示的参数特定于您看到的路径和动词组合 选择。

参数数据类型

/admin/消息 路径和 发布 verb组合需要以下参数。对于每个参数,一个方框会显示 要输入的值的数据类型。


                POST动词和/admin/messages路径的身体参数。

参数类别

参数可分为三类:

  • 路径 – 用于替换 指定路径。此值指定操作的目标 – 对于 例如, {msg_id} 在路上 /admin/messages/{msg_id}.

  • 质疑 – 查询的字段(例如, 定义搜索GET命令)。

  • 身体 – 通常包含用于 使用POST命令创建或使用PUT命令更新。

参数 将参数分组到 相应类别。例如,路径和动词组合 /admin/messages/{msg_id}/put 都有 路径身体 参数:


              中的参数类别 REST资源管理器 选项卡
                云 Gem 门户.

查看参数描述

您可以查看参数描述并确定需要哪些参数, 是可选的。

要查看参数说明

  • 对于 参数 将指针停在 参数的问号图标。

    
                  查看每个参数的工具提示中的摘要信息

必需和可选参数

您还可以确定参数是必需的还是可选的,如 包装盒。

  • 可选参数有虚线框:

    
                  一个可选参数 REST资源管理器
                    选项卡
  • 所需参数有实线包装盒:

    
                  需要的参数 REST资源管理器
                    选项卡。

在以下示例中, /admin/messages/{msg_id} 路径和 动词,只有 msg_id信息 参数是必需的。


                所需参数为带实线的包装盒

输入路径和动词组合的任何必需参数信息后 你可以发送请求,并在 REST 探索者 选项卡。您所输入的参数将根据其数据进行验证 类型以及是否需要它们。

发送测试请求

  1. 对于 身体 信息 参数,输入一些文本,然后点击 发送.

    
                在 REST
                    探索者 选项卡。
  2. 如果您指定了所需参数,则可以查看请求和响应 在 发送 按钮。

    
                事后请求和回复文本

    如果您发送请求时未指定所需参数, REST资源管理器 返回错误。

    
                请求的参数错误缺失 REST
                    探索者 选项卡。

您可以发送GET请求以从特定位置检索信息。的 按照以下过程继续当天示例的信息,然后检索信息 发布于。

发送GET请求

  1. REST资源管理器 “每日消息”云选项卡 确保 /admin/消息 被选中。

  2. 对于 言语,选择 获得.

    
                选择 获得 动词 REST
                    探索者 选项卡。

    质疑 GET请求的参数。

    
                查询参数
  3. 在下表中输入值。

    参数 价值
    指数 0
    过滤器 active
    计数 1
  4. 点击 发送. 请求和回复显示在可滚动的 包装盒。

    注意

    GET请求中的查询串包含您 指定的。

    
                GET请求和响应的文本

如需进一步调查和故障排除,您可以直接从 REST资源管理器 选项卡, API 网关 话务台。

导航至 API 网关 话务台终点

  1. REST资源管理器 选项卡,点击弹窗图标, 主人. 控制台在新的浏览窗口中打开。

    
                点击弹窗图标, 主人 导航至
                  API 网关 话务台。
  2. 登录 AWS 管理控制台 如果您尚未在中登录。的 API 网关 话务台 显示您选择的终点。

    获取更多信息 API 网关,请参阅 API 网关 开发人员指南.

    
                终点 API 网关 话务台