跳到主要内容

Cloud 快速开始

这条路径把一份规范从你的机器带到可分享的文档页面和 MCP 端点。

1. 登录​

在登录页用 Google 或 GitHub 继续。OAuth 握手之后，Powerduck 创建自己的会话并把你带入控制台。个人组织会自动创建。

2. 添加规范​

在仪表盘用一种受支持的来源添加规范：

  • 文件上传——直接上传 OpenAPI 文件；
  • Git 仓库——指向某个仓库并选择分支和文件路径；
  • URL——从 URL 导入规范。

已有的 OpenAPI 3.0/3.1 和 Swagger 文档会被升级，cURL 或 Postman 输入可在保存前转换以供预览。

直接上传如何工作​

大文件直接上传到对象存储，而不是经 API 中转：

  1. 创建一个文档；
  2. 应用用内容类型和大小请求一个上传 URL；
  3. 文件通过预签名 URL 直接上传到存储；
  4. 上传被完成，记录版本及其 SHA-256。

这让 API 服务器不处于大型载荷的数据路径上。

3. 选择暴露操作​

规范就位后，选择哪些操作公开可用。操作可单独切换；源文档保持不动。可从全部启用开始，再为内部或管理接口收窄集合。

4. 打开链接​

文档处于活动状态后，文档工作区显示公开地址：

  • Documentation（文档）——公开查看器中渲染的 API 文档；
  • MCP——托管的 Streamable HTTP MCP 端点；
  • 原始规范数据也在一个稳定 URL 上提供。

默认情况下文档启用，仅在你添加密码时才受保护。MCP 可用性及其访问密钥单独配置。

5. 如有需要保护访问​

  • 为文档添加查看密码和可选有效期；
  • 为 MCP 端点生成一个 MCP 访问密钥；
  • 暂停文档可让两者暂时下线。

6. 用版本迭代​

当 API 变化时，把新内容作为新版本上传，而不是替换旧版本。分享链接可指向当前文档或固定到特定版本，因此引用某版本的链接从不会在读者脚下发生变化。

下一步​