Firebase Rules API

Tạo và quản lý các quy tắc xác định thời điểm dịch vụ hỗ trợ Quy tắc bảo mật Firebase sẽ cho phép yêu cầu.

Để biết mô tả về các công cụ bạn có thể sử dụng để quản lý Quy tắc bảo mật của mình, bao gồm API REST này, hãy xem Quản lý và triển khai Quy tắc bảo mật Firebase .

Tổng quan

Quy tắc bảo mật Firebase bao gồm ngôn ngữ và API. Các nhà phát triển viết các quy tắc bằng ngôn ngữ, xuất bản chúng thông qua API, sau đó gửi yêu cầu đến các dịch vụ hỗ trợ Quy tắc bảo mật Firebase. Dịch vụ đánh giá các yêu cầu bằng cách sử dụng bộ quy tắc được cung cấp và xác định xem các yêu cầu đó có được phép hay không.

Các thuật ngữ sau đây được sử dụng trong tài liệu tham khảo này.

  • Source : Ngôn ngữ dành riêng cho miền chứa các quy tắc trong phạm vi service và path mô tả các điều kiện khi một operation request cụ thể có thể được cho phép.

  • Ruleset : Bản sao bất biến liên tục Nội dung Source có tên được tạo.

  • Release : Tham chiếu được đặt tên cho một Ruleset , giúp Ruleset có sẵn để sử dụng và thực thi bởi các dịch vụ hỗ trợ Quy tắc bảo mật Firebase.

Dịch vụ: firebaserules.googleapis.com

Để gọi dịch vụ này, chúng tôi khuyên bạn nên sử dụng thư viện ứng dụng khách do Google cung cấp . Nếu ứng dụng của bạn cần sử dụng thư viện của riêng bạn để gọi dịch vụ này, hãy sử dụng thông tin sau khi bạn thực hiện yêu cầu API.

Tài liệu khám phá

Tài liệu Khám phá là một đặc tả mà máy có thể đọc được để mô tả và sử dụng API REST. Nó được sử dụng để xây dựng thư viện máy khách, plugin IDE và các công cụ khác tương tác với API Google. Một dịch vụ có thể cung cấp nhiều tài liệu khám phá. Dịch vụ này cung cấp tài liệu khám phá sau:

Điểm cuối dịch vụ

Điểm cuối dịch vụ là URL cơ sở chỉ định địa chỉ mạng của dịch vụ API. Một dịch vụ có thể có nhiều điểm cuối dịch vụ. Dịch vụ này có điểm cuối dịch vụ sau và tất cả các URI bên dưới đều liên quan đến điểm cuối dịch vụ này:

  • https://firebaserules.googleapis.com

Tài nguyên REST: v1.projects

phương pháp
test POST /v1/{name=projects/**}:test
Source kiểm tra tính chính xác về cú pháp và ngữ nghĩa.

Tài nguyên REST: v1.projects.releases

phương pháp
create POST /v1/{name=projects/*}/releases
Tạo một Release .
delete DELETE /v1/{name=projects/*/releases/**}
Xóa Release theo tên tài nguyên.
get GET /v1/{name=projects/*/releases/**}
Nhận Release theo tên.
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
Lấy bản thực thi Release để sử dụng khi thực thi các quy tắc.
list GET /v1/{name=projects/*}/releases
Liệt kê các giá trị Release cho một dự án.
patch PATCH /v1/{name=projects/*/releases/**}
Cập nhật Release qua PATCH.

Tài nguyên REST: v1.projects.rulesets

phương pháp
create POST /v1/{name=projects/*}/rulesets
Tạo một Ruleset từ Source .
delete DELETE /v1/{name=projects/*/rulesets/*}
Xóa Ruleset theo tên tài nguyên.
get GET /v1/{name=projects/*/rulesets/*}
Nhận Ruleset theo tên bao gồm nội dung Source đầy đủ.
list GET /v1/{name=projects/*}/rulesets
Chỉ liệt kê siêu dữ liệu Ruleset và tùy chọn lọc kết quả theo tên Ruleset .