如何向 REST Web API 提交请求

请求类型

REST Web API 测试支持不同的 HTTP 方法,这些方法可根据测试目标使用。 选择 GET 请求只需从 Web API 检索数据即可。 尽管请求参数可以包含在 URL 中,但建议使用专用方法将有效负载推送到 API。

若要发送任何自定义信息、更改数据或触发任何流或事件,请使用 POST、PUT 或 PATCH 等请求类型。 在这种情况下,要指定请求正文,请导航到“后数据”部分。

如果将请求类型设置为 POST、PUT 或 PATCH,但不在“发布数据”部分中指定请求参数,则在保存任务后,请求类型将更改回 GET。

认证

如果您的 API 需要身份验证,请在“基本身份验证”部分中提供凭据。 如果使用基于令牌的身份验证,请按照为基于 OAuth 2.0 的 API提供的建议,并类似地配置身份验证参数。

发布数据

在本节中,您可以轻松地提供任何请求实体,如 JSON

要指定请求正文,只需将 JSON 内容粘贴或输入到字段中。 系统将自动分析代码,系统将提示您根据请求正文类型选择内容类型标头。此外,如果需要,还可以提供自定义内容类型标头。

指定后,内容类型将自动添加到“标题”部分。

创建请求集合

您可以在测试中提交尽可能多的请求。 请注意,必须按照必须执行的顺序将所有请求添加到测试中。

要设置多请求测试:

  1. 首先,创建并保存新的休息 Web API 测试。
  2. 若要在测试中设置一系列请求,请在测试列表中从测试的操作菜单中,选择

    “添加目标”。
  3. 设置请求设置并保存更改。 请求将按执行顺序列在设备编辑屏幕上的侧边栏上。 要访问请求参数,请选择侧边栏上的相应项。
  4. 若要从设备的编辑界面中添加下一个请求,请单击边栏上的”加号”按钮。

若要了解有关多目标设备配置和监视的信息,请参阅 在单个设备中添加多个目标

结果验证

通常,仅仅调用 API 是不够的,用于确保 API 响应包含预期接收的数据。 要验证 API 响应,只需查找一些与响应完全匹配的关键字就足够了。 了解 API 响应内容后,您可以在“内容验证”部分中提供关键字。 有关详细信息,请参阅关键字文章。

用例

让我们以电子邮件 REST API 为例。 为了监视服务,我们需要将 POST 请求发送到相应的 API 终结点,以及请求正文中的电子邮件详细信息。 为此,我们必须提供终结点 URL 并选择POST请求类型。

由于电子邮件 REST API 需要基本身份验证,我们还需要在相应的部分提供凭据。

在” 发布数据 “部分中,我们将指定包含电子邮件详细信息的 JSON 数组,并选择标头类型将有效负载推送到 API 终结点。

下一步是指定要在 API 响应中查找的关键字,以便进行验证。

  • REST API 监控

    大多数现代 Web 应用程序使用 REST API 与服务器通信和相互集成。 确保 API 中数据的适当质量,我们确保使用它的整个 Web 服务的质量。

    假设您已为 Web 服务创建了 RESTful API,并且有必要控制所有 API 函数是否正常工作并 24/7 可用。 但是,为什么我们需要测试WEB API,是不是更容易测试用户界面的问题? 让我们讨论 API 测试和监视的最常见优势。

    REST API 测试的第一个优点是,它有助于识别问题的特定来源。 通过测试 API,您可以找到执行哪些特定函数时出错。

    此外,通过 API 测试,您不需要构建专用测试环境来测试 Web 服务功能。 与需要浏览器窗口中用户操作链才能将请求发送到 Web 服务器的 UI 测试相反,可以使用自动工具执行 API 测试和监视以发送特定的终结点请求。 例如,此方法允许您绕过诸如在 GUI 级别发生错误测试失败的问题。

    尽管您可以手动测试所有 API 函数,但此过程既困难又耗时。 此外,每次更改或向 API 添加新功能时,必须再次执行测试,以确保更新未影响 API 功能。 自动 REST API 监控可以避免手动测试的缺点,并可让您的 API 监视例程更上一层楼。

    使用 Dotcom 监视器进行 REST API 监控

    Dotcom 监视器提供两种用于自动 API 性能监控的选项:

    • REST Web API 监视设备。
    • 邮递员集合监控设备。

    要从头开始设置 RESTful API 监视测试,建议使用我们的 REST Web API 监视设备。 这种类型的监视设备允许您使用基本身份验证和 POST 参数向 API 终结点配置简单的 HTTP 请求。

    如果您已经使用邮递员运行 RESTful API 服务的测试,建议将 邮递员集合导入 Dotcom 监视器。 将 Postman 请求的集合导入系统后,可以配置 Postman 集合监视设备 以自动监视 API 服务。

    尽管 REST Web API 设备支持多请求执行,但在某些情况下,配置可能比较棘手。 反过来,如果您熟悉该工具,Postman 非常适合为 REST Web API 监视配置参数化 HTTP 请求和断言测试。

    因此,如果要创建具有复杂 API 调用序列的测试,或者当需要基本身份验证以外的身份验证时,请使用 Postman 创建 API 调用的集合。 然后,只需将其导入到 Dotcom 监视器邮递员收集设备,并设置监视,如 Dotcom 监视器 API 的邮递员监控(收集任务)中所述。 Dotcom 监视器将执行具有指定频率(最多 1 分钟)的 API 调用,生成报告,并将监视错误通知发送到提供的地址。

    请务必查看 Dotcom 监视器 的完整 API 监控工具 套件,以帮助确保 Web 应用程序和服务的可靠性!