发出 API 请求

Swagger 用户界面提供了每个 API 操作的完整详细信息和文档。

开始之前

注意: 使用 API 文档网页执行的任何 API 操作均为实时操作。 请注意,不要错误地创建,更新或删除配置数据或其他数据。

过程

  1. 选择 Help > API Documentation网格管理器 标题。
  2. 选择所需的操作。

    展开 API 操作时,您可以看到可用的 HTTP 操作,例如 GET , PUT , UPDATE 和 DELETE 。

  3. 选择 HTTP 操作可查看请求详细信息,包括端点 URL ,任何必需或可选参数的列表,请求正文示例(如果需要)以及可能的响应。

    Swagger UI 示例
  4. 确定此请求是否需要其他参数,例如组或用户 ID 。然后,获取这些值。您可能需要先发出其他 API 请求,才能获取所需信息。
  5. 确定是否需要修改示例请求正文。如果是,您可以单击 Model 以了解每个字段的要求。
  6. 单击 Try it out
  7. 提供所需的任何参数,或根据需要修改请求正文。
  8. 单击 Execute
  9. 查看响应代码以确定请求是否成功。