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

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

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

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

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

เครื่องมือ	คำอธิบาย
Git	โดยตัวอย่างจะอยู่ใน GitHub หากคุณไม่ได้ติดตั้ง Git โปรดดูที่ วิธีการตั้งค่า GitHub ของ 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. แก้ไขไฟล์นี้เพื่อกำหนดให้องค์กร ที่อยู่อีเมลที่เชื่อมโยงกับชื่อผู้ใช้ของคุณ และสภาพแวดล้อม (เวอร์ชันที่ใช้งานจริงหรือทดสอบ) ที่คุณต้องการทำให้พร็อกซี API ใช้งานได้
4. หลังจากแก้ไข setenv.sh แล้วให้เรียกใช้คำสั่งต่อไปนี้ วันที่

   sh deploy_all.sh

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

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

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

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

จากไดเรกทอรี /sample-proxies/proxy_name ให้เรียกใช้คำสั่ง ดังต่อไปนี้:

sh invoke.sh

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

การแก้ปัญหา

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

• ข้อมูลเบื้องต้นเกี่ยวกับการแก้ปัญหา
• การแก้ปัญหาเกี่ยวกับ Windows/Cygwin

แก้ไขและนำพร็อกซี 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 จะขึ้นอยู่กับ รูปแบบข้อความที่เจาะจง ดังนั้นพร็อกซีอาจต้องเปลี่ยนแปลงการกำหนดค่าเพิ่มเติม