跳到主要内容

调试在线文档

本文将介绍如何在已发布的在线接口文档中开展调试工作。

选择调试环境​

前置条件：发布 API 在线接口文档时，需提前设置环境。

然后前往已发布文档，点击右上角“运行”按钮，选择环境后即可快速发起接口请求。

使用环境变量​

前提条件：发布 API 在线接口文档时，需选择已添加变量的环境。

使用环境变量可以极大地优化在文档中调试接口的效率，你可以在 “在线文档” 中直接修改 “环境变量” 并运行接口调试。

使用示例代码​

你可以使用 API 在线文档中自动生成的示例代码便捷地调试接口。

Run in Apifox 链接 URL 规范​

1. 链接地址​

WEB 版项目地址https://app.apifox.com/project/{项目 ID}
项目内指定接口-文档 Tabhttps://app.apifox.com/project/{项目 ID}/apis/api-{接口 ID}
项目内指定接口-运行 Tabhttps://app.apifox.com/project/{项目 ID}/apis/api-{接口 ID}-run
在线文档 （公开项目）文档主页https://apifox.com/apidoc/project-{项目 ID}
文档内指定接口https://apifox.com/apidoc/project-{项目 ID}/api-{接口 ID}
文档内指定接口-自动打开“运行”模块https://apifox.com/apidoc/project-{项目 ID}/api-{接口 ID}-run

2. 传递环境变量​

功能：通过传参自动设置用户运行时的“环境变量”

使用方式：添加 URL 参数 environment[``变量名``]=``变量值即可，示例：

3. 传递请求参数​

功能：设置“运行”模块的“接口参数”（仅支持项目内指定接口地址-运行 Tab 的情况）

1. 简单模式​

注意：“简单模式”不支持参数名包含中括号的场景，这种场景请使用“高级模式”。

WEB 运行界面，通过 URL 传递参数：

参数类型参数值备注
Query 参数query[xxx]=yyy
Path 参数path[xxx]=yyy
Body 参数body[xxx]=yyyBody 类型为：formdata 或 x-www-urlencoded
Body 参数body=yyy其他 Body 类型
Header 参数header[xxx]=yyy
Cookie 参数cookie[xxx]=yyy
环境变量environment[xxx]=yyy将会保存到默认环境的环境变量里

2. 高级模式​

WEB 运行界面，通过 URL 传递参数。参数 params 的值为以下 JSON 数据 encodeURIComponent 后得到

{

    "query": [

        ["id", "value1"], 

        ["id", "value2"], 

        ["key2", "value3"]

    ],

    "path": [

        ["key1", "value1"], 

        ["key2", "value2"]

    ],

    "body": [

        ["aaa", "value1"], 

        ["key2", "value2"]

    ],

    "header": [

        ["testHeader", "value1"], 

        ["key2", "value2"]

    ], 

    "cookie": [

        ["testCookie", "value1"], 

        ["key2", "value2"]

    ], 

    "environment": [

        ["key1", "value1"], 

        ["key2", "value2"]

    ]

}
参数类型参数值备注
Query 参数query
Path 参数path
Body 参数body若 Body 类型为 formdata 或 x-www-urlencoded 时，body 的值为 json；否则 body 的值为 string
Header 参数header
Cookie 参数cookie
环境变量environment将会保存到默认环境的环境变量里