Antipattern: กำหนด ProxyEndpoints หลายจุดในพร็อกซี API

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล

การกำหนดค่า ProxyEndpoint จะกำหนดวิธีที่แอปไคลเอ็นต์ใช้ API ผ่าน Apigee Edge ProxyEndpoint จะกำหนด URL ของพร็อกซี API และลักษณะการทำงานของพร็อกซี นโยบายที่จะใช้และปลายทางปลายทางที่ต้องการกำหนดเส้นทาง รวมถึงเงื่อนไขที่ต้องปฏิบัติตามเพื่อให้นโยบายหรือกฎกำหนดเส้นทางเหล่านี้ทำงานได้

สรุปคือ การกำหนดค่า ProxyEndpoint จะระบุสิ่งที่ต้องทำเพื่อใช้งาน API

ลายป้องกัน

พร็อกซี API มีปลายทางของพร็อกซีได้อย่างน้อย 1 รายการ การกำหนด ProxyEndpoints หลายรายการเป็นกลไกที่ง่ายและสะดวกในการใช้งาน API หลายรายการในพร็อกซีเดียว ซึ่งจะช่วยให้คุณใช้นโยบายและ/หรือตรรกะทางธุรกิจใหม่ได้ก่อนและหลังการเรียกใช้ TargetEndpoint

ในทางกลับกัน เมื่อกำหนด ProxyEndpoints หลายจุดในพร็อกซี API เดียว คุณจะรวม API จำนวนมากที่ไม่เกี่ยวข้องเป็นอาร์ติแฟกต์เดียว ทำให้อ่าน ทำความเข้าใจ แก้ไขข้อบกพร่อง และดูแลรักษาพร็อกซี API ได้ยากขึ้น ซึ่งลบล้างปรัชญาหลักของพร็อกซี API ซึ่งก็คือการทำให้นักพัฒนาซอฟต์แวร์สร้างและจัดการ API ได้โดยง่าย

มีอิทธิพล

ProxyEndpoints หลายจุดในพร็อกซี API สามารถทำสิ่งต่อไปนี้ได้

  • ทำให้นักพัฒนาซอฟต์แวร์ทำความเข้าใจและดูแลรักษาพร็อกซี API ได้ยาก
  • สร้างความสับสนให้กับข้อมูลวิเคราะห์ โดยค่าเริ่มต้น ข้อมูลวิเคราะห์จะรวบรวมที่ระดับพร็อกซี จะไม่มีการแสดงรายละเอียดของเมตริกตามปลายทางของพร็อกซี เว้นแต่คุณจะสร้างรายงานที่กำหนดเอง
  • ทำให้การแก้ปัญหาเกี่ยวกับพร็อกซี API ทำได้ยาก

แนวทางปฏิบัติแนะนำ

เมื่อคุณใช้พร็อกซี API ใหม่หรือออกแบบพร็อกซี API ที่มีอยู่ใหม่ ให้ทำตามแนวทางปฏิบัติแนะนำต่อไปนี้

  1. ใช้พร็อกซี API 1 รายการกับ ProxyEndpoint รายการเดียว
  2. หากมี API หลายรายการที่ใช้เซิร์ฟเวอร์เป้าหมายร่วมกันและ/หรือต้องใช้ตรรกะเดียวกันก่อนหรือหลังการเรียกใช้เซิร์ฟเวอร์เป้าหมาย ให้พิจารณาใช้โฟลว์ที่แชร์เพื่อนำตรรกะดังกล่าวไปใช้งานในพร็อกซี API ที่แตกต่างกัน
  3. หากมี API หลายรายการที่ใช้เส้นทางฐานเริ่มต้นร่วมกัน แต่มีส่วนต่อท้ายแตกต่างกัน ให้ใช้โฟลว์แบบมีเงื่อนไขใน ProxyEndpoint เดียว
  4. หากมีพร็อกซี API ที่มี ProxyEndpoints หลายจุดและไม่มีปัญหาอะไร คุณก็ไม่จำเป็นต้องดำเนินการใดๆ

การใช้ ProxyEndpoint 1 รายการต่อพร็อกซี API จะทำให้เกิดสิ่งต่อไปนี้

  1. จัดการพร็อกซีได้ง่ายและง่ายขึ้น
  2. ระบบจะรายงานข้อมูลที่ดีกว่าใน Analytics เช่น ประสิทธิภาพของพร็อกซีและเวลาตอบสนองเป้าหมายแยกกันแทนที่จะรายงานแบบรวมสำหรับ ProxyEndpoints ทั้งหมด
  3. การแก้ปัญหาที่รวดเร็วขึ้น

อ่านเพิ่มเติม