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

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

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

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

   sh deploy_all.sh

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