查看 API 文档

接口元数据

这部分展示了 API 的各种基本信息，比如 URL、请求方式、修改时间、描述等。你可以在生成文档时选择要显示哪些字段。

• 接口状态
  已发布状态的 API 不会显示状态标签；其他状态（比如 “开发中”）的 API 会在名称后面显示状态标签。被标记为 “将废弃” 的 API 在左侧目录树中会显示一条删除线，如 “接口名称”。

  

• 接口描述
  接口描述中的 Markdown 内容会显示在元数据的底部。

调试

点击后会展开调试面板，你可以在这里发送请求、修改参数，还可以切换请求的环境。这里可用的环境就是创建文档时选择的那些环境。

:::tip[]
如果你在创建文档时选择了云端 Mock 环境，相当于给文档阅读者开启了一个简单的沙箱环境。
:::

发送请求后，你可以在页面上看到响应结果和实际发送的请求内容。

使用变量

如果请求示例中用到了{{variables}}变量，阅读者在使用 “调试” 功能时，需要先设置这些变量的值才能发送请求。

请求参数

参数和请求体的规范说明。Apifox 支持两种参数展示样式，你可以在 项目设置 - 功能设置 - 接口功能设置 中选择现代风格或经典风格。