Basic terminology

Application Programming Interface หรือ API คืออินเทอร์เฟซที่ช่วยให้แอปพลิเคชันหนึ่ง ใช้ ความสามารถหรือข้อมูลจากแอปพลิเคชันอื่นได้ง่าย

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

Apigee มีข้อมูลมากมายเกี่ยวกับ API และแนวทางปฏิบัติแนะนำสำหรับการพัฒนา และการใช้ API หากต้องการเริ่มต้นใช้งาน โปรดดูการบรรยายผ่านเว็บเรื่องการออกแบบ API หรือ ดาวน์โหลด eBook ฟรี Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love

Facade ใน Edge สำหรับ API อย่างน้อย 1 รายการ บริการ HTTP ทั่วไป หรือแอปพลิเคชัน (เช่น Node.js)

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

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

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

Apigee จะเพิ่มชื่อที่แสดง และคำอธิบายลงใน URI ดิบเหล่านี้เพื่อให้จัดการ API ได้ง่ายขึ้น Edge ช่วยให้คุณแนบนโยบายและโค้ดกับ URI ได้ ซึ่งช่วยให้คุณ ควบคุมและจัดการลักษณะการทำงานของ API ได้อย่างละเอียด

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

คีย์ API จะผูกกับผลิตภัณฑ์ API อย่างน้อย 1 รายการ ซึ่งจะบังคับใช้การผูกระหว่างแอป และชุด URI ที่แอปได้รับอนุญาตให้ใช้

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

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

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

• โดยทั่วไปจะใช้สภาพแวดล้อม test ในการติดตั้งใช้งานพร็อกซี API ระหว่างการพัฒนา
• โดยทั่วไปจะใช้สภาพแวดล้อม prod ในการเลื่อนระดับพร็อกซี API จากสภาพแวดล้อมการทดสอบ หลังจากที่พัฒนาและทดสอบอย่างสมบูรณ์แล้ว

คอนเทนเนอร์สำหรับออบเจ็กต์ทั้งหมดในบัญชี Apigee Edge ซึ่งรวมถึงพร็อกซี API, ผลิตภัณฑ์ API แพ็กเกจ API, แอป และนักพัฒนาแอป

คุณต้องมีบัญชีผู้ใช้สำหรับแต่ละองค์กรที่คุณเป็นสมาชิก (ผู้ใช้ส่วนใหญ่จะมีบัญชีในองค์กรเดียวเท่านั้น)

ขั้นตอนการประมวลผลที่ดำเนินการเป็นหน่วยตรรกะที่นำกลับมาใช้ใหม่ได้และเป็นหน่วยย่อยภายในโฟลว์การประมวลผลของพร็อกซี API

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

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

เวอร์ชันของอินเทอร์เฟซ API ที่นักพัฒนาแอปใช้

เช่น pivotaltracker.com/services/v3 หรือ api.enterprise.apigee.com/v1

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