Apidog 发布的 API 文档提供了交互式、全面的 API 视图。当用户访问你的文档 URL 时，他们会看到每个端点的结构化展示，其中包含多个便于理解和测试的部分。文档结构#
元数据#
此部分显示 URL、HTTP 方法、修改时间和描述等基本端点信息。你可以在创建文档时选择要显示的字段。端点状态#
状态为“Released”的端点不会显示状态标签。其他状态（如“Developing”）的端点会在端点名称后显示状态标签。状态为“Deprecated”的端点会在左侧目录树中显示为“端点名称”。端点描述#
端点描述中的 Markdown 内容会被渲染并显示在元数据部分的末尾。Try It Out#
点击“Try it out”可展开交互式测试层，你可以在其中发送请求、修改参数并切换环境。可用环境是在创建文档时所选择的环境。如果你在创建文档时选择 Cloud mock 环境，则相当于为读者提供了一个用于测试 API 的简单沙盒环境。 使用变量#
如果请求示例中使用了 {{variables}}，读者必须在发送请求前设置变量值。使用凭证#
配置身份验证设置后（例如使用 Bearer Token 身份验证），你将在“Publish Documentation”面板顶部看到“Credentials”部分，可以在其中直接输入 token 值。这种配置方式的主要好处是，身份验证信息可以在不同 API 之间共享。如果多个 API 引用了相同的安全方案或身份验证类型，你只需输入一次身份验证信息，其他 API 就可以自动复用它。这些凭证会被加密并存储在浏览器的 LocalStorage 中，并基于浏览器会话进行管理。在同一会话内，它们可以在多个窗口和标签页之间共享。一旦浏览器关闭并且会话结束，这些凭证会自动失效。更具体地说：存储在 LocalStorage 中的凭证是加密的，而解密密钥存储在会话 cookie 中。虽然 LocalStorage 中的数据会长期保留，但会话 cookie 中的解密密钥会在浏览器关闭后立即过期。因此，加密数据将无法再被解密或访问，下次访问时你需要重新输入凭证。此部分显示参数和主体规范。Apidog 支持两种参数显示样式——Modern 或 Classic，你可以在 Settings → Feature Settings → Endpoint Feature Settings 中选择。请求示例#
多种编程语言的请求代码示例。你可以在创建分享时选择是否显示此模块。响应规范和示例，其显示方式与 Apidog 客户端中相同。如果你在创建文档时选择了“Allow exporting data”，读者将在右下角和文档最底部看到 Export 选项。读者可以在“Clone”和“Export”之间选择。“Export”支持以 OAS、HTML、Markdown 和 Apidog 格式导出。 Modified at 2026-06-09 08:55:47
