คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่
เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล
ในฐานะผู้ให้บริการ คุณพัฒนา API เพื่อการใช้งานโดยแอปไคลเอ็นต์ หากต้องการสร้าง กำหนดค่า และดูแลรักษาพร็อกซี API และผลิตภัณฑ์ API คุณจะใช้ UI หรือส่งคำขอ HTTP ไปยัง API สำหรับเข้าถึงบริการ RESTful ดังที่อธิบายไว้ในส่วนต่อไปนี้
ใช้ Edge UI
UI ของ Apigee Edge เป็นเครื่องมือบนเบราว์เซอร์ที่ใช้สร้าง กำหนดค่า และจัดการได้ พร็อกซี API และผลิตภัณฑ์ API ชุดย่อยของงานจะทำได้โดยใช้ API เท่านั้น ด้วย
ตารางต่อไปนี้อธิบายวิธีเข้าถึง Edge UI
ผลิตภัณฑ์ | ชื่อ UI | URL การเข้าถึง |
---|---|---|
Edge | UI ของ Edge | หากต้องการเข้าถึง Edge UI ให้ใช้ URL ต่อไปนี้ https://apigee.com/edge สำหรับบทแนะนำเกี่ยวกับการใช้ Edge UI โปรดดู สร้างพร็อกซี API แรก |
Edge สำหรับ Private Cloud | EDGE UI แบบคลาสสิก | หากต้องการเข้าถึง Edge UI สำหรับ Edge สำหรับ Private Cloud ให้ใช้ URL ต่อไปนี้ http://ms-ip:9000 โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ |
เมื่อใช้ Edge UI คุณจะทำสิ่งต่อไปนี้ได้
- สร้างพร็อกซี API โดยการแก้ไขโค้ดและติดตามโฟลว์คำขอผ่านพร็อกซีของคุณ
- สร้างผลิตภัณฑ์ API ที่รวมพร็อกซีเพื่อแสดงคำขอของไคลเอ็นต์
- จัดการนักพัฒนาแอปและแอปของนักพัฒนาซอฟต์แวร์
- กำหนดค่าสภาพแวดล้อมการทดสอบและสภาพแวดล้อมการใช้งานจริง
- ใช้งานแอปพลิเคชัน JavaScript และ Node.js
รูปภาพต่อไปนี้แสดงเครื่องมือแก้ไขพร็อกซี API ใน UI ที่ใช้สร้างและกำหนดค่า พร็อกซี API:
ใช้ Edge API
คุณใช้ Edge API เพื่อจัดการทรัพยากร API ได้ นอกจากนี้ API ยังมอบการเข้าถึงความสามารถในระดับต่ำที่ไม่สามารถเข้าถึงโดย UI
ปลายทาง API มักจะรับข้อมูลการกำหนดค่าและกำหนดให้คุณต้อง
ส่งผ่านข้อมูลการตรวจสอบสิทธิ์ เช่น ชื่อผู้ใช้และรหัสผ่าน เพื่อเข้าถึงข้อมูลดังกล่าว กำลังติดตาม RESTful
ตามหลักการ คุณสามารถเรียก HTTP GET
, POST
, PUT
และ
DELETE
เมธอดในทรัพยากร API ใดก็ได้
ดูรายการ Apigee Edge API ทั้งหมดได้ที่ เอกสารอ้างอิง Apigee Edge API
ทำความเข้าใจฐานของ Edge API เส้นทาง
เส้นทางที่คุณจะใช้ในคำขอ API เชื่อมโยงกับข้อมูลต่อไปนี้
- เส้นทางฐานที่มีชื่อองค์กรของคุณอยู่ ดังตัวอย่างต่อไปนี้
https://api.enterprise.apigee.com/v1/organizations/org_name
- ปลายทางที่ชี้ไปยังทรัพยากร Edge ที่คุณกำลังเข้าถึง
ตัวอย่างเช่น ถ้าชื่อองค์กรของคุณคือ apibuilders
ทุกการโทรที่คุณโทรไปยัง
API จะใช้เส้นทางฐานต่อไปนี้
https://api.enterprise.apigee.com/v1/organizations/apibuilders
หากต้องการเรียกข้อมูลรายการพร็อกซี API ในองค์กร คุณจะต้องเรียกใช้ GET ที่
https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis
ทรัพยากรจำนวนมากถูกกำหนดขอบเขตตามสภาพแวดล้อม สภาพแวดล้อมจะมี 2 แบบโดยค่าเริ่มต้น ได้แก่ การทดสอบและ Prod เช่น แคชจะกำหนดขอบเขตตามสภาพแวดล้อม แคชที่แชร์ที่ชื่อ "mycache" รวม โดยค่าเริ่มต้นในทุกสภาพแวดล้อม
คุณสามารถแสดงรายการแคชโดยเรียกใช้ GET บนทรัพยากรของแคช ดังนี้
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches
ตรวจสอบสิทธิ์การเข้าถึง
คุณต้องตรวจสอบสิทธิ์ของตนเองกับเซิร์ฟเวอร์ API เมื่อเรียกใช้ API คุณทำได้ ด้วยวิธีใดวิธีหนึ่งต่อไปนี้
- OAuth2
- SAML
- การตรวจสอบสิทธิ์พื้นฐาน (ไม่แนะนำ)
นอกจากนี้ Apigee ยังแนะนำให้คุณใช้การตรวจสอบสิทธิ์แบบ 2 ปัจจัยตามที่อธิบายไว้ใน เปิดใช้งาน การตรวจสอบสิทธิ์แบบ 2 ปัจจัยสำหรับบัญชี Apigee
ขีดจำกัดของ Edge API
แต่ละองค์กรจะมีอัตราการโทร Edge API ดังต่อไปนี้เท่านั้น
- การโทร 10,000 ครั้งต่อนาทีสำหรับองค์กรที่ใช้แพ็กเกจแบบชำระเงิน
- การโทร 600 ครั้งต่อนาทีสำหรับองค์กรที่ทดลองใช้
รหัสสถานะ HTTP 401
และ 403
จะไม่นับรวมในขีดจํากัดนี้ การโทรที่เกินจำนวนครั้งที่กำหนด
ขีดจำกัดจะแสดงรหัสสถานะ 429 Too Many Requests
เคล็ดลับในการทำงานกับ Edge API
ส่วนนี้จะอธิบายเทคนิคบางอย่างที่ทำให้ทำงานกับ Edge API ได้ ได้ง่ายยิ่งขึ้น
ตัวย่อ URL คำขอ
เมื่อสร้าง URL คำขอไปยัง Edge API คุณจะใช้สิ่งต่อไปนี้ได้ อักษรย่อ:
/e = /environments
/o = /organizations
/r = /revisions
หากใช้ตัวย่อ คุณต้องใช้ตัวย่อดังกล่าวอย่างสม่ำเสมอ กล่าวคือ ให้ย่อองค์ประกอบทั้งหมดใน ตามที่กล่าวไว้ข้างต้นและในตัวอย่างต่อไปนี้ หรือไม่มีเลย การใช้ทั้งองค์ประกอบแบบเต็มและองค์ประกอบแบบย่อในเส้นทางเดียวกันจะทำให้เกิดข้อผิดพลาด
เช่น
THIS: https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/environments/prod/apis/helloworld/revisions/1/deployments CAN BE MUCH SHORTER: https://api.enterprise.apigee.com/v1/o/ahamilton-eval/e/prod/apis/helloworld/r/1/deployments
เรียกใช้คำสั่ง curl
ใช้ไคลเอ็นต์ HTTP เพื่อส่งคำขอไปยัง API หลายตัวอย่างในเอกสารประกอบ
ให้ตัวอย่างคำขอ API โดยใช้ curl
ซึ่งเป็นไคลเอ็นต์ HTTP ที่ใช้กันอย่างแพร่หลาย หากคุณจำเป็นต้องทำดังนี้
ติดตั้ง curl
คุณสามารถดาวน์โหลดได้จาก
http://curl.haxx.se.
การเรียก API ที่รองรับการบีบอัด gzip เปิดอยู่
คำตอบ หากคุณตั้งค่า 'Accept-Encoding: gzip, deflate'
ในการเรียก API รายการใดก็ตาม
การตอบสนองที่มีขนาดใหญ่กว่า 1024 ไบต์จะส่งคืนในรูปแบบ gzip
การจัดรูปแบบคำขอและการตอบกลับ XML และ JSON
Edge API จะแสดงข้อมูลเป็น JSON โดยค่าเริ่มต้น สำหรับคำขอหลายรายการ คุณจะได้รับการตอบกลับ
ส่งกลับมาเป็น XML แทน โดยตั้งค่าส่วนหัวของคำขอ Accept
เป็น
application/xml
ตามตัวอย่างต่อไปนี้
curl -H "Authorization: Bearer `get_token`" \ -H "Accept: application/xml" \ https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \ | xmllint --format -
การตอบกลับควรมีลักษณะดังต่อไปนี้
<List> <Item>SOAP-Message-Validation-1</Item> <Item>Spike-Arrest-1</Item> <Item>XML-to-JSON-1</Item> </List>
โปรดทราบว่าตัวอย่างนี้ใช้ prettyprint
เพื่อแสดงผลลัพธ์โดยเชื่อมโยงการตอบกลับผ่าน
xmllint
ยูทิลิตี acurl
ไม่รองรับส่วนหัว Accept
ด้วยเหตุนี้ คุณจึงสามารถ
รับการตอบกลับรูปแบบ JSON ด้วย acurl
เท่านั้น
หากต้องการใช้ prettyprint
สำหรับการตอบกลับ JSON คุณสามารถใช้ไลบรารี Python json.tool
ได้ดังนี้
curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \ -H "Accept: application/json" \ -H "Authorization: Bearer `get_token`" \ | python -m json.tool
ตัวอย่างคําตอบมีดังนี้
[ "SOAP-Message-Validation-1", "Spike-Arrest-1", "XML-to-JSON-1" ]
สำหรับ XML คุณสามารถใช้ xmllint
ได้
curl https://ahamilton-eval-test.apigee.net/getstarted -u email_address | xmllint --format -
เมื่อโพสต์หรือวางเพย์โหลดใน XML ให้ใช้ส่วนหัว HTTP ของ Content-type
ดังนี้
acurl -H "Content-type:text/xml" -X POST -d \ '<XMLPayload> </XMLPayload> ' \ https://api.enterprise.apigee.com/v1/organizations/apifactory/apis -u email_address
สภาพแวดล้อมการทำให้ใช้งานได้
ทุกองค์กรที่ใช้ Apigee Edge โดยค่าเริ่มต้นจะมีสภาพแวดล้อมอย่างน้อย 2 สภาพแวดล้อมที่ใช้เพื่อทำสิ่งต่อไปนี้ได้ พัฒนา ทดสอบ และทำให้ API ใช้งานได้: "ทดสอบ" และ "prod" ใช้เมธอด "test" ที่จะพัฒนาและทดสอบ API ของคุณก่อนเผยแพร่ต่อสาธารณะ เฉพาะนักพัฒนาซอฟต์แวร์ภายในเท่านั้นที่เข้าถึง API ได้ ที่ใช้กับสภาพแวดล้อมการทดสอบแล้ว ทำให้ API ใช้งานได้ใน "prod" เผยแพร่ต่อสาธารณะ ที่พร้อมให้บริการแก่นักพัฒนาแอป
การแก้ไขข้อบกพร่องและการทดสอบ
Apigee มีเครื่องมือติดตามที่ช่วยให้คุณแก้ไขข้อบกพร่องได้ คำขอและการตอบกลับจากต้นทางถึงปลายทาง ขั้นตอน ผลลัพธ์การติดตามจะแสดงส่วนหัวคำขอและการตอบกลับ รวมถึงเพย์โหลด การดำเนินนโยบาย และข้อผิดพลาดที่อาจเกิดขึ้นระหว่างโฟลว์
จุดข้อมูลสําคัญสําหรับใช้ในการแก้ปัญหา
- การประทับเวลา: ใช้การประทับเวลาเพื่อดูระยะเวลาที่แต่ละขั้นตอนใช้ในการดำเนินการ การเปรียบเทียบการประทับเวลาจะช่วยให้คุณสามารถแยกนโยบายที่ใช้เวลาดำเนินการนานที่สุด กำลังทำให้การเรียก API ของคุณช้าลง
- เส้นทางฐาน: การยืนยันเส้นทางฐานจะทำให้มั่นใจได้ว่านโยบาย กำหนดเส้นทางข้อความไปยังเซิร์ฟเวอร์ที่ถูกต้อง
- ผลของการดำเนินการนโยบาย: ผลลัพธ์เหล่านี้ช่วยให้คุณเห็นได้ว่าข้อความ มีการเปลี่ยนแปลงตามที่คาดไว้ เช่น ถ้าข้อความกำลังเปลี่ยนจาก XML เป็น JSON หรือหาก กำลังแคชข้อความอยู่
รูปต่อไปนี้แสดงผลลัพธ์การติดตาม
เซสชันการติดตามแต่ละเซสชันแบ่งออกเป็นขั้นตอนสำคัญดังนี้
- คำขอเดิมที่ได้รับจากไคลเอ็นต์: แสดงเส้นทางกริยาและ URI ของ คำขอจากแอปไคลเอ็นต์ ส่วนหัว ข้อมูลเนื้อหา และพารามิเตอร์การค้นหา
- คำขอที่ส่งไปยังบริการแบ็กเอนด์ของคุณ: แสดงข้อความคำขอที่ส่งไปยัง บริการแบ็กเอนด์โดยพร็อกซี API
- การตอบกลับที่บริการแบ็กเอนด์แสดงผล: แสดงส่วนหัวการตอบกลับ และเพย์โหลดที่แสดงผลโดยบริการแบ็กเอนด์
- ส่งการตอบกลับสุดท้ายไปยังไคลเอ็นต์แล้ว: ข้อความตอบกลับแสดงผลไปยัง กำลังส่งคำขอแอปไคลเอ็นต์เมื่อดำเนินการขั้นตอนการตอบกลับแล้ว