跳转到内容
搜索文档

构建开发人员门户

最后更新 查看 MarkdownAgent 设置

在保存 端点 后,API Shield 便可以充当 API 目录。API Shield 可以根据其对您 API 的了解构建交互式文档门户,或者您可以上传新的 OpenAPI 架构文件临时构建文档门户。

要创建开发人员门户:

  1. 在 Cloudflare 仪表板中,前往安全 Settings(设置) 页面。

    Go to Settings ↗
  2. API 滥用 过滤。

  3. Create developer portal(创建开发者门户) 上,选择 Create site(创建站点)

  4. 上传 OpenAPI v3.0 架构文件,或选择从 API Shield 中选择现有架构。

  5. 选择 Download project files(下载项目文件),以在本地保存将上传到 Cloudflare Pages 的文件副本。如果您希望以任何方式修改项目,然后手动将新版本上传到 Pages,下载项目文件可能会很有帮助。

  6. 选择 Create Pages project(创建 Pages 项目) 开始创建项目。系统将自动创建一个新的 Pages 项目,并自动将您的 API 架构以及其他支持的静态内容上传到该项目中。

  7. 选择 Deploy site(部署站点)

  1. 登录到 Cloudflare 仪表板,然后选择您的账户和域。

  2. 转到 Security(安全性) > API Shield > Settings(设置)

  3. Create developer portal(创建开发者门户) 下,选择 Create site(创建站点)

  4. 上传 OpenAPI v3.0 架构文件,或选择从 API Shield 中选择现有架构。

  5. 选择 Download project files(下载项目文件),以在本地保存将上传到 Cloudflare Pages 的文件副本。如果您希望以任何方式修改项目,然后手动将新版本上传到 Pages,下载项目文件可能会很有帮助。

  6. 选择 Create Pages project(创建 Pages 项目) 开始创建项目。系统将自动创建一个新的 Pages 项目,并自动将您的 API 架构以及其他支持的静态内容上传到该项目中。

  7. 选择 Deploy site(部署站点)

自定义域

要创建自定义的 vanity 域名而不是使用 pages.dev 域名,请参阅 Pages 自定义域文档

可用性

所有订阅了 API Shield 的客户都可以构建开发人员门户。此功能使用 Cloudflare Pages 来托管生成的门户。有关当前订阅计划的任何限制,请参阅 Pages

限制

此功能目前使用来自 Redocly 的开源 Redoc 项目。有关自定义主题和品牌选项,请访问 Redoc GitHub 仓库

要修改生成的页面,请在创建 Pages 项目之前下载项目文件。您可以使用所做的修改后的文件来创建一个新的 Pages 项目,以满足您的品牌设计指南。

这篇文档对您有帮助吗?