แชร์ผ่าน


โครงสร้างเอกสารของ Fabric REST API

Microsoft Fabric REST API ถูกออกแบบมาเพื่อช่วยให้นักพัฒนาสามารถทํา Fabric ให้เป็นอัตโนมัติได้ หน้าการอ้างอิง Fabric REST API (เอกสาร) มีโครงสร้างเพื่อช่วยให้นักพัฒนาค้นหาข้อมูลที่ต้องการได้

หน้าอ้างอิงจะถูกแบ่งออกเป็นสองส่วนหลัก:

  • API หลัก - Api หลักให้ข้อมูลและฟังก์ชันการทํางานสําหรับทุกรายการภายใน Microsoft Fabric API หลักไม่ได้เฉพาะเจาะจงสําหรับปริมาณงานหนึ่งปริมาณ และสามารถใช้ได้กับปริมาณงานทั้งหมด API หลักคือ API สร้าง อ่าน อัปเดต และลบ (CRUD) คุณสามารถใช้เพื่อสร้างหรืออัปเดตรายการ Fabric ควบคู่ไปกับคุณสมบัติทั่วไป API หลักสามารถใช้ในขณะดําเนินการชุดงานที่ไม่บังคับให้มีการจัดการคุณสมบัติใด ๆ ที่เฉพาะเจาะจงกับประเภทรายการเฉพาะ

  • ปริมาณงาน API - API ปริมาณงานกําหนดเป้าหมายประเภทรายการเฉพาะใน Fabric

ส่วนหน้าการอ้างอิงปริมาณงานและหลักแสดง API ทั้งหมดตามลําดับตัวอักษร แต่ละส่วนประกอบด้วยภาพรวมที่มีรายการของ API ทั้งหมดในส่วน และรายการ API ที่เรียงตามตัวอักษรของ API ในส่วนนี้

รายการเฉพาะสินค้า

รายการเฉพาะส่วนรายละเอียดข้อมูลจําเพาะของแต่ละรายการชนิดในผ้า รายการชนิดสินค้าแต่ละรายการประกอบด้วย:

  • ภาพรวม: คําอธิบายย่อๆ เกี่ยวกับชนิดสินค้า

  • จุดสิ้นสุด: แสดงรายการจุดสิ้นสุดที่พร้อมใช้งานสําหรับชนิดหน่วยข้อมูล พร้อมกับรายละเอียดเกี่ยวกับพารามิเตอร์ รูปแบบคําขอและการตอบสนอง และตัวอย่าง

  • แบบจําลอง: กําหนดแบบจําลองข้อมูลสําหรับชนิดรายการ โดยระบุคุณสมบัติและชนิด

  • การดําเนินการ: แสดงรายการการดําเนินการที่พร้อมใช้งานสําหรับชนิดรายการ รวมถึงรายละเอียดเกี่ยวกับพารามิเตอร์ คําขอ และรูปแบบการตอบสนอง และตัวอย่าง

ใช้รายการเฉพาะรายการเพื่อทําความเข้าใจลักษณะเฉพาะของ API ที่เกี่ยวข้องกับประเภทรายการที่ระบุและสําหรับคําแนะนําในการดําเนินการที่เกี่ยวข้องกับรายการประเภทนั้น

โครงสร้างหน้าการอ้างอิง

แต่ละหน้าอ้างอิงมีส่วนต่อไปนี้:

  • ภาพรวม - ย่อหน้าสั้น ๆ ที่ด้านบนของบทความที่อธิบาย API

  • สิทธิ์ - รายการสิทธิ์ของผู้ใช้ที่จําเป็นสําหรับการเรียก API

  • ขอบเขตที่จําเป็น - รายการสิทธิ์ (หรือที่เรียกว่าขอบเขต) ที่ API ต้องการ

  • ข้อจํากัด - (ไม่บังคับ) รายการของข้อจํากัดสําหรับ API

  • อินเทอร์เฟซ - แสดงรูปแบบ HTTP ของ API

  • พารามิเตอร์ URI - รายการพารามิเตอร์ที่ใช้เพื่อระบุทรัพยากรหรือทรัพยากรเฉพาะ

  • เนื้อความของคําขอ - รายการของคุณสมบัติที่สามารถส่งผ่านไปยัง API

  • การตอบสนอง - รายการการตอบกลับที่เป็นไปได้จาก API

  • ตัวอย่าง - รายการตัวอย่างที่แสดงวิธีการใช้ API

  • ข้อกําหนด - พารามิเตอร์ที่กําหนดโครงสร้างและคุณสมบัติของออบเจ็กต์ที่สามารถส่งผ่านไปยัง API

โครงสร้างการอ้างอิงเอกสาร API ใหม่มีจุดมุ่งหมายเพื่อให้วิธีการเข้าถึงและการใช้ข้อมูล API ที่ชัดเจนและสอดคล้องกัน ด้วยการแยกส่วน CORE และรายการเฉพาะรายการ เราหวังว่าจะทําให้นักพัฒนาค้นหาและใช้ข้อมูลที่พวกเขาต้องการเพื่อรวมกับบริการ Microsoft Fabric ได้ง่ายขึ้น

เรายินดีรับคําติชมและคําแนะนําของคุณเกี่ยวกับวิธีปรับปรุงคู่มือและ API