跳到主要内容

外部调用OpenAPI

Q1. 什么是 Apipost 生成的“外部调用 OpenAPI”接口?

Apipost能够生成符合 OpenAPI 标准的接口定义。定义中详细描述了API的路径(URL)、请求方式(GET/POST等)、参数和返回格式。 生成完成后,请求的工具或环境(如 cURL、Apipost、编程语言 HTTP 库、其他应用程序等)都可以根据此接口定义,直接发起请求调用您的 API。这极大简化了跨平台和多应用的数据交互,使集成和管理变得更加方便和自动化。

image.png

如何使用“外部调用 OpenAPI”功能?

您可以通过以下方式快速获取并使用 OpenAPI 接口信息进行测试或集成:

调用类型操作步骤结果
HTTP接口调用1. 目录树-右键单击目标接口
2. 选择菜单中的「外部调用 OpenAPI
3. 在弹出窗口中点击「测试 API
在 Apipost 内自动打开 HTTP 标签页,可直接进行接口调用测试。
接口用例调用1. 在接口用例详情页点击「测试」按钮右侧的下拉
2. 选择菜单中的「外部调用 OpenAPI
3. 在弹出窗口中点击「测试 API」
在 Apipost 内自动打开 SSE 标签页,可直接进行该用例的接口调用测试。
自动化测试调用1. 目录树-右键单击目标用例
2. 选择「外部调用 OpenAPI
3.在弹出窗口中点击「测试 API」
在 Apipost 内自动打开 SSE 标签页,可直接进行该用例的接口调用测试。

说明: 点击「测试 API」后,Apipost 会自动在平台内打开一个新的 HTTP/SSE 标签页,其中已填充好该接口/用例的完整请求信息(URL、方法、参数、Headers 等),方便您立即进行测试验证。

如何快速测试 OpenAPI 接口?

  1. 按照上述 如何使用“外部调用 OpenAPI”功能? 中的步骤,找到并点击「外部调用 OpenAPI」

  2. 在弹出的「外部调用 OpenAPI」窗口中,点击醒目的「测试 API」按钮。

  3. Apipost 将自动导航到 API 管理界面,并在一个新的 HTTP/SSE 标签页中打开该接口的完整请求配置,供您直接执行测试。

接口-OpenAPI调用: image.png 接口用例/自动化测试-OpenAPI调用: image.png


常见问题解答 (FAQ)

Q:如何直接在外部工具(如命令行、Apipost、代码)中调用这个 API?

A: 在「外部调用 OpenAPI」弹窗中,找到并点击「复制接口的 cURL」按钮。这将把该接口的完整 cURL 命令复制到剪贴板。您可以将此命令粘贴到命令行终端直接执行,或在 Apipost 等工具的 "Import" 中粘贴以快速创建请求,或者根据 cURL 命令编写您的程序代码。cURL 命令包含了接口地址、方法、认证信息(如需要)、参数和请求体等所有必要细节。