Firebase Rules API

创建和管理规则，以确定启用 Firebase 安全规则的服务何时应允许请求。

有关可用于管理安全规则的工具（包括此 REST API）的说明，请参阅管理和部署 Firebase 安全规则。

概述

Firebase 安全规则由语言和 API 组成。开发人员用该语言编写规则，通过 API 发布它们，然后向支持 Firebase 安全规则的服务提交请求。服务使用提供的规则集评估请求并确定是否应允许该请求。

本参考文档中使用了以下术语。

  • Source ：特定于域的语言，包含service范围内的规则和描述允许特定request operation时的条件的path 。

  • Ruleset ：具有生成名称的持久不可变副本Source内容。

  • Release ：对Ruleset的命名引用，使Ruleset可供支持 Firebase 安全规则的服务使用和执行。

服务：firebaserules.googleapis.com

要调用此服务，我们建议您使用 Google 提供的客户端库。如果您的应用程序需要使用您自己的库来调用此服务，请在发出 API 请求时使用以下信息。

发现文件

发现文档是用于描述和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。该服务提供以下发现文档：

服务端点

服务端点是指定 API 服务的网络地址的基本 URL。一项服务可能有多个服务端点。该服务具有以下服务端点，并且以下所有 URI 均与该服务端点相关：

  • https://firebaserules.googleapis.com

REST 资源： v1.projects

方法
test POST /v1/{name=projects/**}:test
测试Source的语法和语义正确性。

REST 资源： v1.projects.releases

方法
create POST /v1/{name=projects/*}/releases
创建一个Release 。
delete DELETE /v1/{name=projects/*/releases/**}
按资源名称删除Release 。
get GET /v1/{name=projects/*/releases/**}
按名称获取Release 。
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
获取在执行规则时使用的Release可执行文件。
list GET /v1/{name=projects/*}/releases
列出项目的Release值。
patch PATCH /v1/{name=projects/*/releases/**}
通过 PATCH 更新Release 。

REST 资源： v1.projects.rulesets

方法
create POST /v1/{name=projects/*}/rulesets
从Source创建Ruleset 。
delete DELETE /v1/{name=projects/*/rulesets/*}
按资源名称删除Ruleset 。
get GET /v1/{name=projects/*/rulesets/*}
按名称获取Ruleset ，包括完整的Source内容。
list GET /v1/{name=projects/*}/rulesets
仅列出Ruleset集元数据，并可选择按Ruleset集名称过滤结果。