สร้างพร็อกซี API แบบง่าย

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

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

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

ดูวิดีโอนี้เพื่อดูภาพรวมของกระบวนการสร้างพร็อกซี API

การสร้างพร็อกซี API โดยใช้ UI

วิธีที่ง่ายที่สุดในการสร้างพร็อกซี API คือการใช้วิซาร์ดสร้างพร็อกซี

Edge

วิธีเข้าถึงวิซาร์ดสร้างพร็อกซีโดยใช้ UI ของ Edge

  1. ลงชื่อเข้าใช้ apigee.com/edge
  2. เลือกพัฒนา > พร็อกซี API ในแถบนำทางด้านซ้าย
  3. คลิก +Proxy

วิซาร์ดสร้างพร็อกซีจะแสดงและแนะนำขั้นตอนในการสร้างและเพิ่มฟีเจอร์ขั้นต่ำลงในพร็อกซี API

หน้าแรกของวิซาร์ดสร้างพร็อกซีที่มีข้อความแจ้งให้คุณเลือกพร็อกซีแบบย้อนกลับ, บริการ SOAP, ไม่มีเป้าหมาย หรือแพ็กเกจพร็อกซีเพื่อปรับแต่งขั้นตอนของวิซาร์ด

Edge แบบคลาสสิก (ระบบคลาวด์ส่วนตัว)

วิธีเข้าถึงวิซาร์ดสร้างพร็อกซีโดยใช้ UI ของ Edge แบบคลาสสิก

  1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ
  2. เลือก API > พร็อกซี API ในแถบนำทางด้านบน
  3. คลิก + พร็อกซี API

วิซาร์ดสร้างพร็อกซีจะแสดงและแนะนำขั้นตอนในการสร้างและเพิ่มฟีเจอร์ขั้นต่ำลงในพร็อกซี API

หน้าแรกของวิซาร์ดสร้างพร็อกซีที่มีข้อความแจ้งให้คุณเลือกพร็อกซีแบบย้อนกลับ, บริการ SOAP, ไม่มีเป้าหมาย หรือแพ็กเกจพร็อกซีเพื่อปรับแต่งขั้นตอนของวิซาร์ด

หน้าแรกของวิซาร์ดช่วยให้คุณสร้างพร็อกซี API จากแหล่งที่มาต่อไปนี้ได้

ประเภท คำอธิบาย
พร็อกซีแบบย้อนกลับ (พบบ่อยที่สุด)

พร็อกซี API ที่กําหนดเส้นทางคําขอขาเข้าไปยังบริการแบ็กเอนด์ HTTP ที่มีอยู่ อาจเป็น JSON หรือ XML API โปรดดูการสร้างพร็อกซีย้อนกลับสําหรับบริการ HTTP ในส่วนนี้ในภายหลัง

คลิกใช้ข้อกำหนด OpenAPI เพื่อสร้างพร็อกซีจากข้อกำหนด OpenAPI ที่ถูกต้อง ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวเลือกนี้ได้ในส่วนการใช้ข้อกําหนดของ OpenAPI เพื่อสร้างพร็อกซีในภายหลัง
บริการ SOAP พร็อกซี API ที่สร้างขึ้นจากไฟล์ WSDL ดูการเปิดเผยบริการเว็บที่ใช้ SOAP เป็นพร็อกซี API
ไม่มีเป้าหมาย

พร็อกซี API ที่ไม่มีแบ็กเอนด์ API ("ไม่มีเป้าหมาย") คล้ายกับการสร้างพร็อกซีย้อนกลับสําหรับบริการ HTTP ที่อธิบายไว้ก่อนหน้านี้ ยกเว้นคุณจะไม่ได้ระบุ API ที่มีอยู่เมื่อกําหนดรายละเอียดพร็อกซี API

คลิกใช้ข้อกำหนด OpenAPI เพื่อสร้างพร็อกซีจากข้อกำหนด OpenAPI ที่ถูกต้อง ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวเลือกนี้ได้ที่การใช้ข้อกำหนดของ OpenAPI เพื่อสร้างพร็อกซีภายหลังในส่วนนี้
เป้าหมายที่โฮสต์

พร็อกซี API ที่กําหนดเส้นทางไปยังแอปพลิเคชัน Node.js ที่ทําให้ใช้งานได้ในสภาพแวดล้อมเป้าหมายที่โฮสต์ ดูภาพรวมของเป้าหมายที่โฮสต์
อัปโหลด App Bundle ของพร็อกซี กลุ่มพร็อกซี API ที่มีอยู่ (เช่น ตัวอย่างพร็อกซี API รายการใดรายการหนึ่งที่มีอยู่ใน GitHub) ดูการนําเข้าพร็อกซี API จากกลุ่มพร็อกซี API

ส่วนต่อไปนี้อธิบายวิธีสร้างพร็อกซี API โดยใช้แหล่งที่มาแต่ละรายการ

การสร้างพร็อกซีย้อนกลับสําหรับบริการ HTTP

Edge จะสร้างพร็อกซีย้อนกลับตามข้อมูล 2 รายการต่อไปนี้

  • URL ของบริการแบ็กเอนด์
  • เส้นทาง URI ที่ระบุ API ที่ไม่ซ้ำกันซึ่งพร็อกซี API จะแสดงต่อแอปของผู้บริโภค

โดยปกติแล้ว URL บริการแบ็กเอนด์จะแสดงแอปพลิเคชันที่เปิดใช้บริการซึ่งองค์กรของคุณเป็นเจ้าของ และยังชี้ไปยัง API ที่เผยแพร่ต่อสาธารณะได้ด้วย API หรือบริการดังกล่าวอาจอยู่ภายใต้การควบคุมของคุณ (เช่น แอปพลิเคชัน HR ภายในหรือแอปพลิเคชัน Rails ในระบบคลาวด์) หรืออาจเป็น API หรือบริการของบุคคลที่สาม (เช่น Twitter หรือ Instagram)

Edge

  1. เข้าถึงวิซาร์ดสร้างพร็อกซีตามที่อธิบายไว้ในการสร้างพร็อกซี API โดยใช้ UI ก่อนหน้านี้ในส่วนนี้
  2. ในวิซาร์ดสร้างพร็อกซี ให้คลิกพร็อกซีย้อนกลับ (พบบ่อยที่สุด) หากต้องการสร้างพร็อกซีจากข้อมูลจำเพาะ OpenAPI ที่ถูกต้องที่มีอยู่ ให้คลิกใช้ข้อมูลจำเพาะ OpenAPI โปรดดูรายละเอียดเกี่ยวกับตัวเลือกนี้ที่หัวข้อการใช้ข้อมูลจำเพาะ OpenAPI เพื่อสร้างพร็อกซีด้านล่าง
  3. ในหน้ารายละเอียดของวิซาร์ด ให้ป้อนข้อมูลต่อไปนี้
    ช่อง รายละเอียด
    ชื่อ ชื่อที่แสดงสำหรับ API ของคุณ ระบุอักขระที่เป็นตัวอักษรและตัวเลขคละกัน ขีดกลาง (-) หรือขีดล่าง (_)
    เส้นทางฐาน

    ส่วนของ URI ที่ปรากฏหลังที่อยู่ http(s)://[host] ของพร็อกซี API Edge ใช้ URI เส้นทางฐานเพื่อจับคู่และกำหนดเส้นทางข้อความคำขอขาเข้าไปยังพร็อกซี API ที่เหมาะสม

    หมายเหตุ: เส้นทางฐานของพร็อกซี API จะเริ่มต้นด้วยค่าที่ระบุสำหรับฟิลด์ Name ซึ่งแปลงเป็นอักษรตัวพิมพ์เล็กทั้งหมด

    URL ของทรัพยากรเพิ่มเติมจะตามหลังเส้นทางฐาน โครงสร้าง URL แบบเต็มซึ่งไคลเอ็นต์จะใช้เพื่อเรียก API Proxy มีดังนี้

    https://[host]/base_path/conditional_flow_path

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

    ใช้ไวลด์การ์ดในเส้นทางฐาน

    ใช้ไวลด์การ์ด /*/ อย่างน้อย 1 ตัวในเส้นทางฐานของพร็อกซี API เพื่อเตรียมพร้อมรับอนาคต ตัวอย่างเช่น เส้นทางฐานของ /team/*/members อนุญาตให้ไคลเอ็นต์เรียก https://[host]/team/blue/members และ https://[host]/team/green/members ได้โดยไม่ต้องสร้างพร็อกซี API ใหม่เพื่อรองรับทีมใหม่ โปรดทราบว่าระบบไม่รองรับ /**/
    คำอธิบาย (ไม่บังคับ) คำอธิบายของ API
    เป้าหมาย (API ที่มีอยู่) URL ของบริการแบ็กเอนด์ที่พร็อกซี API นี้เรียกใช้
  4. ในหน้านโยบายทั่วไปของวิซาร์ด ให้กําหนดค่าต่อไปนี้
    • ข้อกำหนดการให้สิทธิ์ด้านความปลอดภัยในส่วนความปลอดภัย: การให้สิทธิ์ โปรดดูการเพิ่มความปลอดภัยในส่วนนี้ในภายหลัง
    • การรองรับกลไกการแชร์ทรัพยากรข้ามโดเมน (CORS) ในส่วนความปลอดภัย: เบราว์เซอร์ โปรดดูการเพิ่มการรองรับ CORS ในส่วนนี้
    • โควต้าเพื่อปกป้องบริการแบ็กเอนด์จากการเข้าชมสูงในส่วนโควต้า ดูโควต้า (ใช้ไม่ได้หากเลือกการให้สิทธิ์ผ่าน)
    • การบังคับใช้ขีดจํากัดการสร้างรายได้สําหรับองค์กรที่เปิดใช้การสร้างรายได้ในส่วนการสร้างรายได้ โปรดดูหัวข้อบังคับใช้ขีดจํากัดการสร้างรายได้ในพร็อกซี API
  5. ในหน้าโฮสต์เสมือนของวิซาร์ด ให้เลือกโฮสต์เสมือนที่พร็อกซี API จะเชื่อมโยงเมื่อติดตั้งใช้งาน ดูข้อมูลเพิ่มเติมได้ที่เกี่ยวกับโฮสต์เสมือน
  6. ในหน้าสรุป ให้เลือกสภาพแวดล้อมการทําให้ใช้งานได้ หากต้องการ แล้วคลิกสร้างและทําให้ใช้งานได้

    ระบบจะสร้างและทำให้พร็อกซี API ใหม่ใช้งานได้ในสภาพแวดล้อมที่เลือก

  7. คลิกแก้ไขพร็อกซีเพื่อแสดงหน้ารายละเอียดของพร็อกซี API

Edge แบบคลาสสิก (ระบบคลาวด์ส่วนตัว)

  1. เข้าถึงวิซาร์ดสร้างพร็อกซีตามที่อธิบายไว้ในการสร้างพร็อกซี API โดยใช้ UI ก่อนหน้านี้ในส่วนนี้
  2. ในวิซาร์ดสร้างพร็อกซี ให้เลือก Reverse proxy (พบบ่อยที่สุด) หากต้องการสร้างพร็อกซีจากข้อมูลจำเพาะ OpenAPI ที่ถูกต้องที่มีอยู่ ให้คลิกใช้ OpenAPI โปรดดูรายละเอียดเกี่ยวกับตัวเลือกนี้ที่หัวข้อการใช้ข้อมูลจำเพาะของ OpenAPI เพื่อสร้างพร็อกซีด้านล่าง
  3. คลิกถัดไป
  4. ในหน้ารายละเอียดของวิซาร์ด ให้ป้อนข้อมูลต่อไปนี้
    ช่อง คำอธิบาย
    ชื่อพร็อกซี ชื่อที่แสดงสำหรับ API ของคุณ
    เส้นทางฐานของพร็อกซี

    เส้นทางฐานของพร็อกซีคือ URI เศษที่อยู่หลังที่อยู่ http(s)://[host] ของพร็อกซี API Edge ใช้ URI เส้นทางพื้นฐานเพื่อจับคู่และกำหนดเส้นทางข้อความคำขอที่เข้ามาใหม่ไปยังพร็อกซี API ที่เหมาะสม

    หมายเหตุ: ดูคําแนะนําของ Apigee เกี่ยวกับการกําหนดเวอร์ชัน API ได้ที่การกําหนดเวอร์ชันใน e-book การออกแบบ Web API: ลิงก์ที่ขาดหายไป

    หลังเส้นทางฐานคือ URL ของทรัพยากรเพิ่มเติม โครงสร้าง URL แบบเต็มซึ่งไคลเอ็นต์จะใช้เพื่อเรียกพร็อกซี API มีดังนี้

    https://[host]/base_path/conditional_flow_path

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

    การใช้ไวลด์การ์ดในเส้นทางฐาน

    คุณสามารถใช้ไวลด์การ์ด /*/ อย่างน้อย 1 ตัวในเส้นทางฐานของพร็อกซี API เพื่อเตรียมพร้อมรับอนาคต ตัวอย่างเช่น เส้นทางฐานของ /team/*/members อนุญาตให้ไคลเอ็นต์เรียก https://[host]/team/blue/members และ https://[host]/team/green/members ได้โดยไม่ต้องสร้างพร็อกซี API ใหม่เพื่อรองรับทีมใหม่ โปรดทราบว่าระบบไม่รองรับ /**/

    หมายเหตุ: เส้นทางฐานของพร็อกซีจะเป็นค่าเริ่มต้นที่ระบุสำหรับชื่อพร็อกซีซึ่งแปลงเป็นอักษรตัวพิมพ์เล็กทั้งหมด เว้นแต่คุณจะแก้ไขเนื้อหาในช่องเส้นทางฐานของพร็อกซีอย่างชัดเจน
    API ที่มีอยู่ URL ที่แพลตฟอร์ม API เรียกใช้ในนามของแอปที่เรียกใช้ API ของคุณผ่าน URL ของพร็อกซี API
    คำอธิบาย คําอธิบายของ API
  5. ในหน้าความปลอดภัยของวิซาร์ด ให้กําหนดค่าสิ่งต่อไปนี้
  6. ในหน้าโฮสต์เสมือนของวิซาร์ด ให้เลือกโฮสต์เสมือนที่พร็อกซี API จะเชื่อมโยงเมื่อติดตั้งใช้งาน สำหรับข้อมูลเพิ่มเติม โปรดดูเกี่ยวกับโฮสต์เสมือน
  7. เลือกสภาพแวดล้อมการทำให้ใช้งานได้ แล้วคลิกสร้างและทำให้ใช้งานได้
    ระบบจะส่งการรับทราบเพื่อยืนยันว่ามีการสร้างและทำให้ใช้งานได้พร็อกซี API ใหม่ในสภาพแวดล้อมที่เลือกเรียบร้อยแล้ว
  8. คลิก ดูพร็อกซี <ชื่อพร็อกซี> ในเครื่องมือแก้ไขเพื่อแสดงหน้ารายละเอียดของพร็อกซี API

การนําเข้าพร็อกซี API จากกลุ่มพร็อกซี API

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

รับชมวิดีโอนี้เพื่อเรียนรู้วิธีการสร้างและนำเข้าพร็อกซี API จากแพ็กเกจพร็อกซี API

Edge

วิธีนําเข้าพร็อกซี API จากแพ็กเกจพร็อกซี API

  1. เข้าถึงวิซาร์ดสร้างพร็อกซีตามที่อธิบายไว้ในการสร้างพร็อกซี API โดยใช้ UI ก่อนหน้านี้ในส่วนนี้
  2. คลิกอัปโหลดแพ็กเกจพร็อกซี
  3. ในหน้า อัปโหลดกลุ่มพร็อกซี ในวิซาร์ดพร็อกซี ให้ป้อนข้อมูลต่อไปนี้

    ช่อง คำอธิบาย
    แพ็กเกจ ZIP ไฟล์ ZIP ที่มีการกำหนดค่าพร็อกซี API ลากและวางหรือคลิกเพื่อไปยังไฟล์
    ชื่อ ชื่อที่แสดงสําหรับ API จะเป็นชื่อไฟล์ ZIP โดยไม่มีนามสกุลโดยค่าเริ่มต้น
  4. คลิกถัดไป
  5. ในหน้าสรุป ให้เลือกสภาพแวดล้อมการติดตั้งใช้งาน หากต้องการ แล้วคลิกสร้างและติดตั้งใช้งาน
    ข้อความยืนยันจะปรากฏขึ้นเพื่อยืนยันว่าสร้างพร็อกซี API ใหม่เรียบร้อยแล้ว
  6. คลิกแก้ไขพร็อกซีเพื่อแสดงหน้ารายละเอียดของพร็อกซี API

Edge แบบคลาสสิก (ระบบคลาวด์ส่วนตัว)

  1. เข้าถึงวิซาร์ดสร้างพร็อกซีตามที่อธิบายไว้ในการสร้างพร็อกซี API โดยใช้ UI ก่อนหน้านี้ในส่วนนี้
  2. ในวิซาร์ดสร้างพร็อกซี ให้เลือกแพ็กเกจพร็อกซี
  3. คลิกถัดไป
  4. ในหน้ารายละเอียดในวิซาร์ดพร็อกซี ให้ป้อนข้อมูลต่อไปนี้

    ช่อง คำอธิบาย
    แพ็กเกจ ZIP คลิกเลือกไฟล์ แล้วไปที่ไฟล์ ZIP ที่มีการกำหนดค่าพร็อกซี API
    ชื่อพร็อกซี ชื่อที่แสดงสําหรับ API
  5. ตรวจสอบข้อมูลบิลด์ แล้วคลิกสร้าง
    หากทําสําเร็จ ระบบจะแสดงข้อความและ Edge จะทําให้พร็อกซี API ที่นําเข้าใช้งานได้โดยอัตโนมัติในสภาพแวดล้อมที่เลือกในองค์กร API ที่แสดงโดยพร็อกซี API พร้อมให้เรียกใช้
  6. คลิกดูพร็อกซี <ชื่อพร็อกซี> ในเครื่องมือแก้ไขเพื่อแสดงหน้ารายละเอียดของพร็อกซี API
  7. หากต้องการทำให้พร็อกซีใช้งานได้ ให้คลิกเมนูแบบเลื่อนลงการติดตั้งใช้งาน เลือกสภาพแวดล้อมที่ต้องการทำให้ใช้งานได้ แล้วตอบกลับข้อความแจ้ง

การแสดงบริการเว็บที่ใช้ SOAP เป็นพร็อกซี API

ในวิซาร์ดสร้างพร็อกซี ให้คลิกบริการ SOAP แล้วทําตามวิซาร์ดเพื่อสร้างพร็อกซีแบบส่งผ่านหรือพร็อกซีแบบ REST สําหรับบริการ SOAP โปรดดูรายละเอียดที่หัวข้อการเปิดเผยบริการ SOAP เป็นพร็อกซี API

การเพิ่มความปลอดภัย

ในหน้านโยบายทั่วไป (Edge) หรือความปลอดภัย (Edge แบบคลาสสิก) ของวิซาร์ดสร้างพร็อกซี ให้เลือกประเภทการให้สิทธิ์ด้านความปลอดภัยที่ต้องการเพิ่ม ตารางต่อไปนี้จะสรุปตัวเลือกที่มี

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

เพิ่มการรองรับ CORS

CORS (Cross-Origin Resource Sharing) เป็นกลไกมาตรฐานที่อนุญาตให้เว็บเบราว์เซอร์ส่งคำขอไปยังโดเมนอื่นได้โดยตรง มาตรฐาน CORS จะกำหนดชุดส่วนหัว HTTP ที่เว็บเบราว์เซอร์และเซิร์ฟเวอร์ใช้เพื่อใช้การสื่อสารข้ามโดเมน

คุณสามารถเพิ่มการรองรับ CORS ลงใน API ได้โดยเลือกเพิ่มส่วนหัว CORS ในหน้านโยบายทั่วไป (Edge) หรือความปลอดภัย (Edge แบบคลาสสิก) ของวิซาร์ดสร้างพร็อกซี

ดูข้อมูลโดยละเอียดเพิ่มเติมเกี่ยวกับการรองรับ CORS รวมถึงการเพิ่มการรองรับ CORS ก่อนเข้าสู่ระบบในพร็อกซีได้ที่การเพิ่มการรองรับ CORS ในพร็อกซี API

การใช้ข้อมูลจำเพาะของ OpenAPI เพื่อสร้างพร็อกซี

ส่วนนี้จะกล่าวถึงตัวเลือก "ใช้ OpenAPI" ที่มีให้สำหรับการสร้างพร็อกซี API ประเภทต่างๆ จากข้อมูลจำเพาะ OpenAPI ได้แก่ ย้อนกลับ, Node.js หรือไม่มีเป้าหมาย

ข้อกำหนด OpenAPI คืออะไร

โลโก้ Open API Initiative"Open API Initiative (OAI) มุ่งเน้นการสร้าง พัฒนา และโปรโมตรูปแบบคำอธิบาย API แบบอิสระของผู้ให้บริการโดยอิงตามข้อกำหนดของ Swagger" ดูข้อมูลเพิ่มเติมเกี่ยวกับโครงการ Open API ได้ที่ https://openapis.org

ข้อมูลจำเพาะของ OpenAPI ใช้รูปแบบมาตรฐานเพื่ออธิบาย RESTful API ข้อกำหนด OpenAPI เขียนในรูปแบบ JSON หรือ YAML ซึ่งเครื่องอ่านได้ แต่ก็อ่านและทำความเข้าใจได้ง่ายสำหรับมนุษย์ ข้อกำหนดจะอธิบายองค์ประกอบต่างๆ ของ API เช่น เส้นทางฐาน เส้นทางและคำกริยา ส่วนหัว พารามิเตอร์การค้นหา การดำเนินการ ประเภทเนื้อหา คำอธิบายการตอบกลับ และอื่นๆ นอกจากนี้ ข้อมูลจำเพาะของ OpenAPI ยังมักใช้ในการสร้างเอกสารประกอบของ API ด้วย

ต่อไปนี้คือตัวอย่างจากข้อกำหนด OpenAPI ที่อธิบายบริการเป้าหมายจำลองของ Apigee ซึ่งก็คือ http://mocktarget.apigee.net ดูข้อมูลเพิ่มเติมได้ที่ https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
  /help:
    get:
      summary: Get help
      operationId: Get help
      description: View help information about available resources in HTML format.
      responses:
        "200":
          description: Success
...

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

การสร้างพร็อกซี API จากข้อมูลจำเพาะ OpenAPI

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

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

ดูวิดีโอนี้เพื่อดูวิธีสร้างพร็อกซี API จากข้อกำหนด OpenAPI

การอัปเดตโฟลว์ในพร็อกซี API โดยใช้ข้อมูลจำเพาะ OpenAPI

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

หากต้องการอัปเดตโฟลว์ในพร็อกซี API โดยใช้ข้อกำหนดของ OpenAPI ให้ทำดังนี้

  1. เพิ่มเส้นทางทรัพยากรใหม่ไปยังข้อกำหนดของ OpenAPI ดูการแก้ไขข้อมูลจำเพาะ OpenAPI ที่มีอยู่
  2. เปิด API Proxy ใน UI แล้วคลิกแท็บพัฒนา
  3. ใน Navigator ให้คลิก + ถัดจากปลายทางพร็อกซีที่คุณต้องการอัปเดต
    กล่องโต้ตอบ "โฟลว์แบบมีเงื่อนไขใหม่" จะเปิดขึ้น
  4. คลิกจาก OpenAPI หากยังไม่ได้เลือก
    หากมีทรัพยากรในข้อกําหนดของ OpenAPI ที่ไม่มีโฟลว์แบบมีเงื่อนไขที่สอดคล้องกันในพร็อกซี API ทรัพยากรเหล่านั้นจะแสดงในกล่องโต้ตอบดังที่แสดงในรูปภาพต่อไปนี้ ทรัพยากรที่ไม่ได้แสดงเป็นโฟลว์ในพร็อกซี API ปัจจุบัน ตัวอย่างนี้รวมถึง /loveapis, /ip, /json และ /xml
  5. เลือกทรัพยากรแต่ละรายการที่ต้องการเพิ่มโฟลว์แบบมีเงื่อนไข
  6. คลิกเพิ่ม

ระบบจะเพิ่มขั้นตอนแบบมีเงื่อนไขลงในพร็อกซี API

การสร้างการแก้ไขใหม่ของพร็อกซี API

สร้างการแก้ไขใหม่ของพร็อกซี API ตามที่อธิบายไว้ด้านล่าง

Edge

วิธีสร้างการแก้ไขใหม่ของพร็อกซี API โดยใช้ UI ของ Edge

  1. ลงชื่อเข้าใช้ apigee.com/edge
  2. เลือกพัฒนา > พร็อกซี API ในแถบนําทางด้านซ้าย
  3. คลิกพร็อกซี API ในรายการที่ต้องการคัดลอก
  4. เลือกโปรเจ็กต์ > บันทึกเป็นเวอร์ชันใหม่

Edge แบบคลาสสิก (ระบบคลาวด์ส่วนตัว)

วิธีสร้างพร็อกซี API เวอร์ชันใหม่โดยใช้ Edge UI แบบคลาสสิก

  1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ
  2. เลือก API > พร็อกซี API ในแถบนำทางด้านบน
  3. คลิกพร็อกซี API ในรายการที่ต้องการคัดลอก
  4. เลือกโปรเจ็กต์ > บันทึกเป็นเวอร์ชันใหม่

การคัดลอกพร็อกซี API

คัดลอกพร็อกซี API ที่มีอยู่ไปยังพร็อกซี API ใหม่ตามที่อธิบายไว้ด้านล่าง

Edge

วิธีคัดลอกพร็อกซี API โดยใช้ Edge UI

  1. ลงชื่อเข้าใช้ apigee.com/edge
  2. เลือกพัฒนา > พร็อกซี API ในแถบนําทางด้านซ้าย
  3. คลิกพร็อกซี API ในรายการที่ต้องการคัดลอก
  4. เลือกโปรเจ็กต์ > บันทึกเป็นพร็อกซี API ใหม่
  5. ในกล่องโต้ตอบ "บันทึกเป็นพร็อกซีใหม่" ให้ป้อนชื่อของพร็อกซี API ใหม่
  6. คลิกเพิ่ม

คลาสสิก Edge (Private Cloud)

วิธีคัดลอกพร็อกซี API โดยใช้ UI แบบคลาสสิกของ Edge

  1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ
  2. เลือก API > พร็อกซี API ในแถบนำทางด้านบน
  3. คลิกพร็อกซี API ในรายการที่ต้องการคัดลอก
  4. เลือกโปรเจ็กต์ > บันทึกเป็นพร็อกซี API ใหม่
  5. ในกล่องโต้ตอบ "บันทึกเป็นพร็อกซีใหม่" ให้ป้อนชื่อของพร็อกซี API ใหม่
  6. คลิกเพิ่ม

การสำรองข้อมูลพร็อกซี API

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

การสร้างพร็อกซี API โดยใช้ API

หากต้องการสร้างพร็อกซี API โดยใช้ API โปรดดูAPI พร็อกซี API