การทำให้พร็อกซีใช้งานได้จากบรรทัดคำสั่ง

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

หัวข้อนี้อธิบายวิธีทำให้พร็อกซีใช้งานได้จากบรรทัดคำสั่ง Apigee Edge มีตัวเลือก 2 แบบ สำหรับการทำให้ใช้งานได้จากบรรทัดคำสั่ง ตัวเลือกแรกคือการใช้เครื่องมือทำให้ใช้งานได้ของ Apigee Edge ที่เขียนด้วย Python ส่วนอีกตัวเลือกคือการกำหนดค่าและเรียกใช้สคริปต์ของ Shell

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

หากคุณทำงานใน UI การจัดการเป็นหลัก โปรดดู การทำให้พร็อกซีใช้งานได้ใน UI

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

การเรียกใช้เครื่องมือทำให้ใช้งานได้ของ Apigee Edge Python

เครื่องมือทำให้ใช้งานได้ของ Apigee Edge Python ทำงานร่วมกับ Edge Management API เพื่อนำเข้าและทำให้พร็อกซี API ใช้งานได้ เครื่องมือนี้เป็นส่วนหนึ่งของการเผยแพร่ตัวอย่างแพลตฟอร์ม API ใน GitHub ดู การใช้พร็อกซี API ตัวอย่าง

ใช้เครื่องมือ Apigee Edge Python เพื่อนำเข้า (อัปโหลด) และทำให้ API ใช้งานได้ในกระบวนการเดียวที่ง่ายดาย

ต้องเรียกใช้เครื่องมือทำให้ใช้งานได้จากไดเรกทอรีฐานในการเผยแพร่ตัวอย่างแพลตฟอร์ม API ซึ่งไดเรกทอรีฐานคือไดเรกทอรีระดับบนของไดเรกทอรี setup และ tools

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

python tools/deploy.py -n proxyname -u name:passW -o org -e env -d proxypath -p /

เช่น

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p /

คำสั่งนี้จะบีบอัดไฟล์เป็น ZIP อัปโหลดไฟล์ไปยังองค์กรของคุณใน Apigee Edge และทำให้ไฟล์ใช้งานได้ ในสภาพแวดล้อมที่ระบุ

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

เมื่อดำเนินการสำเร็จ คุณจะเห็นเอาต์พุตในรูปแบบต่อไปนี้

Writing ./<proxybasedir>/apiproxy/weatherapi.xml to apiproxy/weatherapi.xml
Writing ./<proxybasedir>/apiproxy/proxies/default.xml to apiproxy/proxies/default.xml
Writing ./<proxybasedir>/apiproxy/targets/default.xml to apiproxy/targets/default.xml
Imported new proxy version 1
Environment: test
  Revision: 1 BasePath = /
  State: deployed

โดยค่าเริ่มต้น เครื่องมือจะอัปโหลดพร็อกซี API ไปยัง https://api.enterprise.apigee.com, ซึ่งสอดคล้องกับ Edge ในระบบคลาวด์ นอกจากนี้ คุณยังใช้เครื่องมือนี้เพื่ออัปโหลดพร็อกซี API ไปยัง Edge เวอร์ชันในองค์กรได้ด้วยการระบุแฟล็ก -h

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p / -h https://192.168.11.111:8080

ในตัวอย่างนี้ คุณระบุที่อยู่ IP ของเซิร์ฟเวอร์การจัดการ Edge หากคุณสร้าง ระเบียน DNS สำหรับเซิร์ฟเวอร์การจัดการ คุณจะระบุ URL ในรูปแบบต่อไปนี้ได้

https://ms_URL:8080

รายการแฟล็กทั้งหมดสำหรับคำสั่งมีดังนี้

  • -n: ชื่อพร็อกซี API
  • -u: ชื่อผู้ใช้และรหัสผ่านสำหรับบัญชีของคุณในองค์กรใน Apigee Edge
  • -o: ชื่อองค์กรที่คุณมีบัญชี
  • -e: สภาพแวดล้อมที่จะทำให้พร็อกซี API ใช้งานได้ (test หรือ prod)
  • -d: เส้นทางไปยังไดเรกทอรีที่มีไฟล์พร็อกซี API ต้องจัดเก็บไฟล์พร็อกซี API ไว้ในไดเรกทอรีที่ชื่อว่า "apiproxy" ค่านี้คือเส้นทางของ ไดเรกทอรีที่มีไดเรกทอรี "apiproxy" ไม่ใช่เส้นทางไปยัง ไดเรกทอรี "apiproxy" เอง
  • -p: เส้นทาง URI ที่ใช้เป็นการจับคู่รูปแบบเพื่อกำหนดเส้นทางข้อความขาเข้าไปยังการทำให้พร็อกซี API นี้ใช้งานได้ ในกรณีส่วนใหญ่ คุณสามารถตั้งค่านี้เป็น '/' ได้ เว้นแต่ว่าคุณจะมีข้อกำหนดการทำให้ใช้งานได้และการกำหนดเส้นทางขั้นสูง เส้นทางหลักที่ใช้สำหรับการกำหนดเส้นทางพร็อกซี API จะกำหนดไว้ใน ไฟล์การกำหนดค่า ProxyEndpoint ของพร็อกซี API
  • -h: URL ของ Edge โดยค่าเริ่มต้น URL คือ https://api.enterprise.apigee.com, ซึ่งสอดคล้องกับ Edge ในระบบคลาวด์ สำหรับการทำให้ใช้งานได้ในองค์กร ให้ใช้ URL ของเซิร์ฟเวอร์การจัดการ Edge และพอร์ต 8080 ดังตัวอย่างต่อไปนี้
    https://ms_URL:8080

    หรือใช้ที่อยู่ IP ของเซิร์ฟเวอร์การจัดการ ดังตัวอย่าง https://192.168.11.111:8080

การกำหนดค่าและการเรียกใช้เชลล์การทำให้ใช้งานได้ สคริปต์

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

เรียกใช้คำสั่งต่อไปนี้จากไดเรกทอรี /simplyProxy

$ sh deploy.sh

คุณควรเห็นข้อความต่อไปนี้

Enter your password for user {myname} in the Apigee Enterprise organization {org_name}, followed by [ENTER]: 

ป้อนรหัสผ่าน แล้วกด ENTER

จากนั้นคุณควรเห็นข้อความต่อไปนี้

Deploying to test on https://api.enterprise.apigee.com using {myname} on enterprise.apigee.com and {org_name} on enterprise.apigee.com

หากคุณเห็นข้อความต่อไปนี้

Enter your password for user Your USERNAME on enterprise.apigee.com in the Apigee Enterprise organization Your ORG on enterprise.apigee.com, followed by [ENTER]: 

แสดงว่าคุณต้องแก้ไขไฟล์ /setup/setenv.sh ใน การเผยแพร่ตัวอย่างแพลตฟอร์ม ดูวิธีการได้ใน README หรือ Apigee Edge API

เมื่อดำเนินการสำเร็จ เครื่องมือทำให้ใช้งานได้จะบีบอัดไฟล์เป็น ZIP ภายใต้ /apiproxy, นำเข้า แพ็กเกจไปยังองค์กรของคุณใน Apigee Edge แล้วทำให้พร็อกซี API ใช้งานได้ในสภาพแวดล้อม 'test'

พร็อกซี API พร้อมให้เรียกใช้แล้ว