การใช้พร็อกซี API ตัวอย่าง

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

ข้อกำหนดเบื้องต้น

คุณต้องมีบัญชีใน http://enterprise.apigee.com โดยสามารถลงชื่อสมัครใช้ บัญชีทดลองใช้ได้ที่ http://accounts.apigee.com/accounts/sign_up

หากต้องการใช้ตัวอย่าง คุณควรมีสิ่งต่อไปนี้ด้วย

เครื่องมือ คำอธิบาย
Git ตัวอย่างอยู่ใน GitHub หากไม่ได้ติดตั้ง Git โปรดดูวิธีการตั้งค่า Git ของ GitHub หากไม่ต้องการติดตั้ง Git คุณสามารถเรียกดูไฟล์และดาวน์โหลด ZIP ได้จาก https://github.com/apigee/api-platform-samples
Python

คุณต้องมี Python เพื่อเรียกใช้เครื่องมือการติดตั้งใช้งาน Apigee Python มีอยู่ในสภาพแวดล้อม Linux ส่วนใหญ่ ใน Mac ที่ติดตั้ง XCode ในเครื่อง Windows ที่ติดตั้ง Cygwin ที่ติดตั้ง และในที่อื่นๆ อีกมากมาย

หากต้องการรับ Python โปรดดู หน้าดาวน์โหลด Python
curl สคริปต์การตั้งค่าตัวอย่างยังใช้ curl ด้วย ตรวจสอบว่าได้ติดตั้ง curl แล้วและพร้อมใช้งานในเส้นทางของคุณ (เรียกใช้คำสั่ง which curl เพื่อดูว่าพร้อมใช้งานในระบบหรือไม่)
dos2unix หากคุณเรียกใช้ Cygwin ใน Windows คุณอาจต้องใช้ยูทิลิตี dos2unix ด้วย (โปรแกรมติดตั้ง Cygwin ช่วยให้คุณติดตั้งยูทิลิตีได้)

ดาวน์โหลดตัวอย่าง

หากต้องการรับไฟล์ตัวอย่าง ให้ใช้ git clone ดังที่แสดงในตัวอย่างต่อไปนี้

git clone https://github.com/apigee/api-platform-samples.git

นำเข้าและติดตั้งใช้งานพร็อกซี API ตัวอย่าง

นำเข้าและติดตั้งใช้งานตัวอย่างจากบรรทัดคำสั่งโดยทำดังนี้

  1. หลังจากดาวน์โหลดตัวอย่างแล้ว ให้ไปที่ไดเรกทอรี /setup ดังที่แสดงในตัวอย่างต่อไปนี้ 
    cd setup
  2. ในไดเรกทอรี /setup ให้ค้นหาไฟล์ setenv.sh
  3. แก้ไขไฟล์นี้เพื่อตั้งค่าองค์กร อีเมลที่เชื่อมโยงกับชื่อผู้ใช้ และสภาพแวดล้อม (prod หรือ test) ที่คุณต้องการติดตั้งใช้งานพร็อกซี API
  4. หลังจากแก้ไข setenv.sh แล้ว ให้ดำเนินการดังนี้ 
    sh deploy_all.sh

    สคริปต์นี้จะติดตั้งใช้งานตัวอย่างพร็อกซี API ทั้งหมดในองค์กรของคุณ (กระบวนการนี้ใช้เวลา 3-4 นาที) ทำตามข้อความแจ้งเพื่อติดตั้งใช้งานผลิตภัณฑ์ API นักพัฒนาแอป และแอป (ซึ่งใช้สำหรับ OAuth)

  5. หลังจากสคริปต์การติดตั้งใช้งานเสร็จสมบูรณ์แล้ว ให้ไปที่ไดเรกทอรี sample-proxies ใน ไดเรกทอรี sample-proxies คุณจะเห็นไดเรกทอรี 1 ไดเรกทอรีต่อพร็อกซีตัวอย่าง ในแต่ละ ไดเรกทอรีจะมีไฟล์ README.md ที่มีข้อมูลเกี่ยวกับการเรียกใช้ตัวอย่าง และสคริปต์ 2 รายการที่จะ ช่วยคุณในการเปลี่ยนแปลงตัวอย่างเล็กน้อย ติดตั้งใช้งาน แล้วเรียกใช้ตัวอย่างเพื่อดู ผลลัพธ์ของการเปลี่ยนแปลง
    • invoke.sh: เรียกใช้สคริปต์นี้เพื่อเรียกใช้พร็อกซี API เวอร์ชันที่ติดตั้งใช้งาน
    • deploy.sh: เรียกใช้สคริปต์นี้เพื่อติดตั้งใช้งานพร็อกซี API หลังจากทำการเปลี่ยนแปลง

เรียกใช้พร็อกซี API ตัวอย่าง

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

จากไดเรกทอรี /sample-proxies/proxy_name ให้ดำเนินการดังนี้ 

sh invoke.sh

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

การแก้ปัญหา

ดูข้อมูลการแก้ปัญหาได้ที่หัวข้อต่อไปนี้

แก้ไขและนำพร็อกซี API ตัวอย่างกลับมาใช้ใหม่

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

หากต้องการแก้ไขพร็อกซี API ตัวอย่างให้ชี้ไปยังบริการแบ็กเอนด์อื่น ให้แก้ไขไฟล์การกำหนดค่า XML ในตำแหน่งต่อไปนี้

/apiproxy/targets/target_name.xml

ตัวอย่างเช่น หากต้องการให้ตัวอย่างคีย์ API ชี้ไปยังบริการแบ็กเอนด์ของคุณเอง ให้ค้นหาไฟล์นี้

/apikey/apiproxy/targets/default.xml

หากการกำหนดค่าเริ่มต้นชี้ไปที่ http://mocktarget.apigee.net เช่น

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

และบริการแบ็กเอนด์ของคุณพร้อมใช้งานที่ http://api.myproject.com/ ให้คุณ แก้ไขการกำหนดค่าให้มีลักษณะดังต่อไปนี้

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

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

sh deploy.sh

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