Firebase Rules API

สร้างและจัดการกฎที่กำหนดว่าเมื่อใดที่บริการที่เปิดใช้งานกฎความปลอดภัยของ Firebase ควรอนุญาตคำขอ

สำหรับคำอธิบายของเครื่องมือที่คุณสามารถใช้เพื่อจัดการกฎความปลอดภัย รวมถึง REST API นี้ โปรดดูที่ จัดการและปรับใช้กฎความปลอดภัยของ Firebase

ภาพรวม

กฎความปลอดภัยของ Firebase ประกอบด้วยภาษาและ API นักพัฒนาเขียนกฎในภาษา เผยแพร่ผ่าน API จากนั้นส่งคำขอไปยังบริการที่เปิดใช้งานกฎความปลอดภัยของ Firebase บริการประเมินคำขอโดยใช้ชุดกฎที่ให้ไว้และพิจารณาว่าคำขอควรได้รับอนุญาตหรือไม่

มีการใช้คำศัพท์ต่อไปนี้ในเอกสารอ้างอิงนี้

  • Source : ภาษาเฉพาะโดเมนที่มีกฎที่กำหนดขอบเขตเป็น service และ path ที่อธิบายเงื่อนไขเมื่อ operation request เฉพาะอาจได้รับอนุญาต

  • Ruleset : สำเนาถาวรที่ไม่เปลี่ยนรูป เนื้อหา Source ที่มีชื่อที่สร้างขึ้น

  • Release : การอ้างอิงชื่อไปยัง Ruleset ซึ่งทำให้ Ruleset พร้อมใช้งานและบังคับใช้โดยบริการที่เปิดใช้งานกฎความปลอดภัยของ Firebase

บริการ: firebaserules.googleapis.com

หากต้องการเรียกใช้บริการนี้ เราขอแนะนำให้คุณใช้ ไลบรารีไคลเอ็นต์ ที่ Google มอบให้ หากแอปพลิเคชันของคุณจำเป็นต้องใช้ไลบรารีของคุณเองเพื่อเรียกใช้บริการนี้ ให้ใช้ข้อมูลต่อไปนี้เมื่อคุณส่งคำขอ API

เอกสารการค้นพบ

เอกสารการค้นพบ เป็นข้อกำหนดที่เครื่องอ่านได้สำหรับการอธิบายและใช้ REST API ใช้เพื่อสร้างไลบรารีไคลเอ็นต์ ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google API บริการหนึ่งอาจมีเอกสารการค้นพบหลายฉบับ บริการนี้มีเอกสารการค้นพบดังต่อไปนี้:

จุดสิ้นสุดการบริการ

จุดสิ้นสุดของบริการ คือ URL พื้นฐานที่ระบุที่อยู่เครือข่ายของบริการ API บริการหนึ่งอาจมีจุดสิ้นสุดบริการหลายจุด บริการนี้มีจุดสิ้นสุดบริการดังต่อไปนี้ และ 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/**}
อัปเดต Release ผ่าน PATCH

ทรัพยากรส่วนที่เหลือ: v1.projects.rulesets

วิธีการ
create POST /v1/{name=projects/*}/rulesets
สร้าง Ruleset จาก Source
delete DELETE /v1/{name=projects/*/rulesets/*}
ลบ Ruleset ตามชื่อทรัพยากร
get GET /v1/{name=projects/*/rulesets/*}
รับ Ruleset ตามชื่อรวมถึงเนื้อหา Source แบบเต็ม
list GET /v1/{name=projects/*}/rulesets
แสดงรายการข้อมูลเมตา Ruleset เท่านั้น และเลือกกรองผลลัพธ์ตามชื่อ Ruleset ได้