วงจรการพัฒนา API

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

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

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

API ของบริการ API มีเอกสารประกอบอยู่ในการอ้างอิง API ดูการเริ่มต้นใช้งานเอกสารอ้างอิง API

สภาพแวดล้อม

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

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

ระบบจะเปิดใช้ TLS/SSL ของเซิร์ฟเวอร์ขาเข้าโดยอัตโนมัติสำหรับแต่ละสภาพแวดล้อม VirtualHost 2 รายการจะ กำหนดไว้ล่วงหน้าในแต่ละสภาพแวดล้อม ได้แก่ default และ secure ค่าเริ่มต้นจะกำหนดที่อยู่ HTTP ส่วนค่าที่ปลอดภัยจะกำหนดที่อยู่ HTTP/S พร้อม TLS/SSL ฝั่งเซิร์ฟเวอร์ที่กำหนดค่าไว้ล่วงหน้า ในการกำหนดค่าพร็อกซี API คุณจะระบุ VirtualHosts ที่ ProxyEndpoint ควรรับฟัง เมื่อเลื่อนระดับไปยังสภาพแวดล้อมการใช้งานจริง โดยปกติแล้ว คุณจะปิดใช้ HTTP โดยนำ default VirtualHost ออกจากการกำหนดค่าพร็อกซี API

ตัวอย่างเช่น ProxyEndpoint ต่อไปนี้จะรับฟังใน HTTP และ HTTPS

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>default</VirtualHost>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

การลบ default VirtualHost ออกจากการกำหนดค่า ProxyEndpoint จะทำให้คุณ สร้างพร็อกซี API ที่รับฟังเฉพาะ HTTPS และไม่รับฟัง HTTP

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

คุณดูได้ว่ามี VirtualHost ใดบ้างในสภาพแวดล้อมโดยเลือกสภาพแวดล้อมในเมนูหลักของ UI การจัดการ

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

การติดตั้งใช้งานพร็อกซี API ในสภาพแวดล้อม

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

ดูข้อมูลเพิ่มเติมได้ที่ ทำความเข้าใจการติดตั้งใช้งาน

การพัฒนาแบบวนซ้ำในการทดสอบ

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

การเลื่อนเวอร์ชันไปใช้เวอร์ชันที่ใช้งานจริง

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

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

การติดตั้งใช้งานสคริปต์

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

แหล่งข้อมูลด้านสิ่งแวดล้อม

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

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

• URL เป้าหมาย: พร็อกซี API มักจะเรียก URL ของแบ็กเอนด์ที่แตกต่างกันระหว่างการทดสอบและ การใช้งานจริง คุณสามารถใช้การกำหนดค่า TargetServer เพื่อสร้างการกำหนดค่า TargetEndpoint ที่ไม่ขึ้นกับสภาพแวดล้อม ได้ ดู การปรับสมดุลโหลดในเซิร์ฟเวอร์แบ็กเอนด์
• แคชและแผนที่คีย์/ค่า: ทรัพยากรการคงอยู่ทั้ง 2 รายการมีขอบเขตตามสภาพแวดล้อม คุณควร ตรวจสอบว่าได้ใช้รูปแบบการตั้งชื่อเพื่อให้พร็อกซี API จัดเก็บข้อมูลได้โดยไม่ต้อง เปลี่ยนแปลงการกำหนดค่าในระหว่างการเลื่อนขั้น ดู การสร้างและแก้ไขแคชสภาพแวดล้อม
• เป้าหมาย ServiceCallout: ServiceCallout อาจใช้เป้าหมายที่แตกต่างกันโดยขึ้นอยู่กับ สภาพแวดล้อม เช่น หาก ServiceCallout ในสภาพแวดล้อมการทดสอบใช้บริการสาธิต ดูนโยบายข้อความไฮไลต์ของบริการ

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

ดูข้อมูลเพิ่มเติมได้ที่ทำความเข้าใจการติดตั้งใช้งาน