หน้านี้ได้รับการแปลโดย Cloud Translation API

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

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

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

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

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

ดูวิดีโอนี้เพื่อดูข้อมูลเบื้องต้นเกี่ยวกับสภาพแวดล้อม API และวงจรการพัฒนา API

สภาพแวดล้อม

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

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

ขาเข้า, TLS/SSL ของเซิร์ฟเวอร์จะเปิดใช้โดยอัตโนมัติสำหรับแต่ละสภาพแวดล้อม ระบบจะกําหนดค่า VirtualHost 2 รายการล่วงหน้าในแต่ละสภาพแวดล้อม ได้แก่ default และ secure ค่าเริ่มต้นจะกำหนดที่อยู่ HTTP ส่วนความปลอดภัยจะกำหนดที่อยู่ 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>

การลบ 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 หลังการทดสอบ

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

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

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

ขณะที่คุณทำงานกับพร็อกซี API บริการ API จะบันทึกการกำหนดค่าซ้ำเป็นการแก้ไข เมื่อทําให้การทํางานของพร็อกซี API ใช้งานได้ คุณจะเลือกการแก้ไขที่ต้องการเพื่อทําให้ใช้งานได้ โดยทั่วไปแล้ว คุณจะทำให้การแก้ไขล่าสุดใช้งานได้ และหากจำเป็น ก็เปลี่ยนกลับไปใช้หมายเลขการแก้ไขก่อนหน้า คุณเลือกที่จะติดตั้งใช้งานการแก้ไขเหล่านั้นได้ เช่น คุณสามารถโปรโมตการแก้ไขเป็นเวอร์ชันที่ใช้งานจริงเพื่อให้นักพัฒนาแอปเริ่มใช้งาน 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 จัดเก็บข้อมูลได้โดยไม่ต้องเปลี่ยนแปลงการกำหนดค่าในระหว่างการโปรโมต ดูหัวข้อการสร้างและแก้ไขแคชสภาพแวดล้อม
เป้าหมาย ServiceCallout: ข้อความไฮไลต์บริการอาจใช้เป้าหมายที่แตกต่างกันโดยขึ้นอยู่กับสภาพแวดล้อม เช่น หาก ServiceCallout ในสภาพแวดล้อมการทดสอบใช้บริการเดโม ดูนโยบายข้อความไฮไลต์เกี่ยวกับบริการ

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

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