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

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

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

บริการ API มีเครื่องมือและ RESTful API ที่ช่วยให้คุณผสานรวมการใช้งานพร็อกซี API ได้ และการจัดการไว้ใน SDLC ขององค์กรคุณ การใช้งานทั่วไปของ RESTful API คือการเขียน สคริปต์หรือโค้ดที่ทำให้พร็อกซี API ใช้งานได้แบบเป็นโปรแกรม หรือที่ย้ายข้อมูลพร็อกซี API จากพร็อกซี ไปยังสภาพแวดล้อมอื่น โดยเป็นส่วนหนึ่งของกระบวนการอัตโนมัติที่มีขนาดใหญ่ขึ้น ซึ่งยังทำให้ แอปพลิเคชัน บริการ API ไม่ได้ตั้งสมมติฐานเกี่ยวกับ 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/S โดยใช้ TLS/SSL ฝั่งเซิร์ฟเวอร์ที่กำหนดค่าไว้ล่วงหน้า ใน การกำหนดค่าพร็อกซี API คุณจะต้องระบุว่า VirtualHost ใดที่ ProxyEndpoint ควรรับฟัง ขณะโปรโมตเป็นเวอร์ชันที่ใช้งานจริง โดยทั่วไปแล้วคุณจะต้องปิดใช้ HTTP โดยนำ default ออก VirtualHost จากการกำหนดค่าพร็อกซี API

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

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

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

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

คุณสามารถดูว่า VirtualHosts ใดใช้งานได้ในสภาพแวดล้อมด้วยการเลือก สภาพแวดล้อมในเมนูหลัก UI การจัดการ

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

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

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

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

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

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

การโปรโมตสำหรับ Prod

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

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

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

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

ทรัพยากรด้านสิ่งแวดล้อม

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

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

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

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

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