高效的 API 协作需要无缝的文档共享。快速分享通过提供即时的在线文档链接,消除了来回传递 Word 或 PDF 文件的低效做法。此功能支持团队之间快速沟通,让你能够与协作者分享特定 API 端点,同时保持对访问权限、可见性和过期时间的控制。前提条件#
创建快速分享#
点击 +New 创建新的快速分享。一个项目支持多个快速分享,可分发给不同的协作者。所有团队成员都可以查看团队中任何人创建的快速分享。配置选项#
标题:此分享的名称,仅在 Apidog 团队内部可见,用于内部识别,不会显示在共享文档中。
环境:选择在线文档中可用的环境。默认情况下,不会选择任何环境。你可以选择多个环境。所选环境将在文档中对阅读者可见,并且在使用“Try it out”时可用于发送请求。
如果你在创建文档时选择云端模拟环境,则会为阅读者提供一个简单的沙盒环境来测试 API,而不会影响生产系统。
文档内容:文档包含两个可选组件:Base URL 和请求示例。你可以选择是否在文档中显示它们。Base URL:这是环境中设置的基础 URL。如果选中,文档中的每个接口都会显示完整 URL;如果未选中,文档中的 URL 将以“/”开头。
请求示例:是否显示调用请求的示例代码。详情请参阅请求示例。 在端点描述上方显示“Last Modified”时间。
在文档末尾显示“Last Modified”时间。
允许“Export”、“Clone”数据:是否允许阅读者以 OAS/Markdown/HTML/Apidog 格式导出和克隆数据。
分享范围:选择此分享中要包含哪些 API 端点和 Markdown。你可以按目录或筛选器选择,并按标签排除。你也可以选择分享整个文件夹。 安全:你可以设置访问此文档是否需要密码,以及此文档的过期时间。如果未选择过期时间,则永不过期。
显示 API 字段:你可以设置这些字段是否显示在文档中。包括:所有者、更新时间、OperationId、原始链接、需要授权。
语言:此处的语言设置会影响文档中的功能性固定文本,例如“Query Params”“Request samples”等,但不会影响 API 文档内容中编写的文本。
CORS 代理:你可以部署并配置 CORS 代理服务器,以处理 API 文档上的端点请求。了解更多。 高级设置:配置隐藏“Try it out”按钮和隐藏“Powered by Apidog”等选项。
请求示例#
创建分享时,你可以选择是否显示请求代码示例。
如何自定义请求示例:1.
在 设置 → 功能设置 → 端点功能设置 → 端点字段 中,启用请求示例字段
分享整个文件夹#
快速分享支持 Share entire folder,非常适合在分享后仍会继续添加或移除文档的场景。启用后,协作者将自动访问该文件夹中的所有文档,而无需你为每个新文档调整分享设置。在 Scope to Share 部分,选择 Manual Selection 即可看到 Share entire folder 选项。启用后,协作者将自动访问该文件夹中的所有文档。CORS 代理配置#
与外部用户共享 API 文档时,他们在浏览器中直接测试端点时可能会遇到跨源资源共享(CORS)问题。CORS 代理通过指定的代理代理转发请求来解决此问题,从而绕过浏览器 CORS 限制,并实现顺畅的 API 测试。要配置 CORS 代理,请在创建新的共享文档时点击设置选项。默认情况下,Apidog 提供 Cloud Agent 来管理所有共享文档中的端点请求。CORS 代理选项#
云代理:使用 Apidog 的 Cloud Agent 处理端点请求。注意:Cloud Agent 无法访问内部网络上的端点
浏览器扩展:使用安装在用户浏览器中的浏览器扩展。未安装扩展的用户在发起请求前会被提示安装
无代理:请求直接从用户浏览器发送。请确保你的端点服务器已正确配置以处理 CORS