ประเด็นสําคัญของการพัฒนาพร็อกซี API

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

หัวข้อนี้จะแสดงลักษณะพื้นฐานของพร็อกซี API พร้อมกับลิงก์ไปยังข้อมูลเพิ่มเติม

API คือจุดเริ่มต้นที่แอปพลิเคชันหนึ่งใช้ความสามารถของอีกแอปพลิเคชันหนึ่ง คุณใช้พร็อกซี API เพื่อสร้าง API

ใน Apigee Edge คุณใช้พร็อกซี API ได้โดยการกำหนดค่าตรรกะพร็อกซี API เป็นลำดับขั้นตอนที่ดำเนินการกับคำขอจากโค้ดของไคลเอ็นต์ คุณแสดงพร็อกซี API แก่ไคลเอ็นต์โดยการกำหนดปลายทางที่มี URL พร้อมเส้นทางทรัพยากร, คำกริยา HTTP, ข้อกำหนดด้านเนื้อหา และอื่นๆ

แม้ว่าจะเรียกว่าพร็อกซี API แต่จากมุมมองของรหัสไคลเอ็นต์ คือ API

สำหรับภาพรวมของพร็อกซี API โปรดดูการทำความเข้าใจ API และพร็อกซี API

คุณจัดเรียงลำดับตรรกะของพร็อกซี API โดยใช้โฟลว์

ในแอปพลิเคชันใดๆ ข้อมูลจะไหลผ่านแอปพลิเคชันตามตรรกะเงื่อนไข ใน Apigee Edge เส้นทางการประมวลผลจะประกอบด้วยโฟลว์ โฟลว์คือลำดับของขั้นตอน (หรือ "ขั้นตอน") ที่ประกอบกันเป็นเส้นทางการประมวลผลของพร็อกซี API โฟลว์คือวิธีที่ Apigee Edge ได้มอบพื้นที่ให้คุณนำตรรกะและพฤติกรรมไปใช้ในที่เฉพาะ ตั้งแต่ไคลเอ็นต์ไปจนถึงทรัพยากรแบ็กเอนด์ แล้วจึงกลับไปยังไคลเอ็นต์

ดูข้อมูลเพิ่มเติมเกี่ยวกับโฟลว์ได้ที่การควบคุมวิธีที่พร็อกซีดำเนินการกับโฟลว์

คุณเข้าถึงข้อมูลสถานะผ่านตัวแปรโฟลว์ที่สร้างโดยพร็อกซี API

พร็อกซี API มีสิทธิ์เข้าถึงตัวแปรที่แสดงถึงสถานะการดำเนินการ คุณจะเข้าถึงตัวแปรเหล่านี้ได้จาก XML ที่กำหนดค่าพร็อกซีและนโยบาย API นอกจากนี้ คุณยังเข้าถึงตัวแปรเหล่านั้นได้เมื่อขยายพร็อกซี API ด้วยภาษาแบบขั้นตอน เช่น Java, JavaScript หรือ Python

ตัวแปรเหล่านี้ถือโดย Apigee Edge มีบางพร็อพเพอร์ตี้อยู่แล้วโดยค่าเริ่มต้น ซึ่งโดยปกติแล้วจะเป็นสิ่งที่พบได้บ่อยในสิ่งที่พร็อกซี API ทำ (เช่น เพราะเป็นส่วนหนึ่งของคำขอ HTTP) คุณยังสร้างตัวแปรของคุณเองเพื่อให้เป็นไปตามข้อกำหนดด้านตรรกะได้

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับตัวแปร โปรดดูการจัดการสถานะพร็อกซีด้วยตัวแปรโฟลว์

คุณสามารถทำให้พร็อกซี API ดำเนินการอย่างมีเงื่อนไขได้

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับการดำเนินการแบบมีเงื่อนไขได้ที่ตัวแปรโฟลว์และเงื่อนไข

คุณใช้ตรรกะส่วนใหญ่ในพร็อกซี API โดยใช้นโยบาย

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับนโยบายที่นโยบายคืออะไร

คุณใส่ชุดฟังก์ชันการทำงานที่นำกลับมาใช้ใหม่ได้

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนที่แชร์ได้ที่ขั้นตอนที่แชร์ซึ่งนำมาใช้ซ้ำได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับการเชื่อมโยงพร็อกซี API ได้ที่พร็อกซี Chaining API ร่วมกัน

คุณสามารถแก้ไขข้อบกพร่องของพร็อกซีด้วยเครื่องมือติดตาม

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับการแก้ไขข้อบกพร่องด้วย Trace ได้ที่การใช้เครื่องมือติดตาม

คุณจัดการกับข้อผิดพลาดเกี่ยวกับพร็อกซีของ API ที่ผิดพลาด

เมื่อกำหนดค่าเครื่องจัดการข้อผิดพลาด คุณสามารถปรับแต่งข้อผิดพลาดที่ส่งคืนไปยังไคลเอ็นต์ API ได้ ตัวแฮนเดิลข้อผิดพลาดช่วยให้คุณควบคุมข้อความแสดงข้อผิดพลาดได้ว่าข้อผิดพลาดนั้นเกิดจากโค้ดของคุณเองหรือจากคอมโพเนนต์ที่รวมไว้ (เช่น นโยบาย)

ดูข้อมูลเพิ่มเติมได้ที่การจัดการข้อผิดพลาด