使用 API Shield 界面配置 API 架构验证,该功能会根据您提供的 API 架构 验证请求。
在为 API 配置架构验证之前,您必须获取一个符合我们规范的 API 架构文件。
如果您处于架构验证 2.0 中,您可以更改您的设置,但无法添加任何新的经典架构验证架构。
要在 Cloudflare 仪表板中配置架构验证:
- 登录到 Cloudflare 仪表板 ↗并选择您的账户和域。
- 选择 Security(安全性) > API Shield。
- 前往 Schema validation(架构验证) 并选择 Add schema(添加架构)。
- 为您的策略输入描述性名称,并可选择编辑触发架构验证的表达式。例如,如果您的 API 位于
http://api.example.com/v1,请包含对 主机名 字段的检查 — 等于api.example.com— 以及使用正则表达式对 URI 路径 字段的检查 — 匹配正则^/v1。
- 选择 Next(下一步)。
- 上传您的架构文件。
- 选择 Save(保存) 以验证架构文件的内容并部署架构验证规则。如果您遇到验证错误,请确保使用的是支持的文件格式之一,并且每个端点和方法配对都具有唯一的 operation ID。
部署 API Shield 规则后,Cloudflare 会显示所有按其保护级别以及针对不合规和未受保护的请求将执行的操作进行组织的 API 端点 摘要。
- 在 Endpoint action(端点操作) 下拉菜单中,为每个针对受保护端点且未能通过架构验证的请求选择一个操作。
- 在 Fallthrough action(兜底操作) 下拉菜单中,为每个针对未受保护端点的请求选择一个操作。
- (可选)您可以通过选择 Save new endpoints to Endpoint management(保存新端点到端点管理),在保存架构的同时将端点保存到端点管理。无论架构是保存为草稿还是发布上线,端点都将被保存。
- 选择 Done(完成)。