คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่
เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล
สิ่งที่คุณจะได้เรียนรู้
ในบทแนะนำนี้ คุณจะได้เรียนรู้เกี่ยวกับสิ่งต่อไปนี้
- สร้างพร็อกซี Edge API จากไฟล์ WSDL
- ทราบความแตกต่างระหว่างพร็อกซีประเภท RESTful SOAP และ SOAP แบบส่งผ่าน พร็อกซี
ในบทแนะนำนี้ คุณจะได้เรียนรู้วิธีเพิ่มพร็อกซี Edge API ไว้หน้าเว็บที่ใช้ SOAP service.
บทแนะนำนี้จะแสดงวิธีสร้าง RESTful API ใหม่หน้า SOAP ที่ใช้ service. แม้ว่าจะไม่มีการอธิบายรายละเอียดในส่วนนี้ แต่คุณก็สร้างพร็อกซีแบบ Pass-through ได้ ที่ยอมรับเพย์โหลด SOAP และส่งไปยังบริการแบ็กเอนด์
สิ่งที่ต้องมี
- บัญชี Apigee Edge หากยังไม่มี คุณสามารถลงชื่อสมัครใช้พร้อมคำแนะนำ ที่การสร้าง Apigee บัญชี Edge
กำลังสร้างพร็อกซี
ในขั้นตอนนี้ Edge จะสร้างพร็อกซีที่จะแสดงหน้าบริการ SOAP พร็อกซี SOAP API มี 2 ประเภท ได้แก่
- พร็อกซีประเภท REST-SOAP-REST จะสร้าง RESTful API ใหม่พร้อมคำแปล ไปยัง SOAP ลูกค้าเรียกใช้โปรแกรมนี้เช่นเดียวกับบริการ RESTful อื่นๆ โดยส่งต่อคำค้นหา พารามิเตอร์ที่บริการแบ็กเอนด์ต้องการ Edge แปลค่าสิ่งนี้เป็นเพย์โหลด SOAP ที่บริการต้องการ
- ประเภทพร็อกซีพร็อกซีแบบ Pass-through จะช่วยให้ไคลเอ็นต์สามารถส่งผ่านในเพย์โหลด SOAP ได้อย่างง่ายดาย วิธีนี้ทำให้การเรียกใช้บริการ SOAP ได้รับประโยชน์จากฟีเจอร์การจัดการ Edge
Edge
วิธีพร็อกซีบริการ SOAP โดยใช้ Edge UI
- ลงชื่อเข้าใช้ apigee.com/edge
- เลือก Develop > พร็อกซี API ในแถบนำทางด้านซ้าย
- คลิก +พร็อกซี
- คลิกบริการ SOAP
- ในหน้ารายละเอียดพร็อกซี ให้ป้อนข้อมูลต่อไปนี้
ช่อง คำอธิบาย แหล่งที่มา WSDL เลือก: URL
คัดลอกและวาง URL WSLD ต่อไปนี้ในช่องป้อน URL
https://ws.cdyne.com/delayedstockquote/delayedstockquote.asmx?wsdl
คลิก: ตรวจสอบ
Apigee Edge ได้รับไฟล์ WSDL และอ่านเพื่อค้นหารายการการดำเนินการ ที่บริการ SOAP รองรับ
ชื่อ ปล่อยไว้ตามเดิม:
delayedstockquote
นี่คือชื่อสำหรับพร็อกซี API ที่คุณกำลังสร้าง
เส้นทางพื้นฐาน ปล่อยไว้ตามเดิม: /delayedstockquote
คำอธิบาย เลือกเพิ่มคำอธิบาย เช่น พร็อกซี WSDL API ราคาหุ้น - คลิกถัดไป
- ในส่วนความปลอดภัย: การให้สิทธิ์ ให้เลือกผ่าน (ไม่มีการให้สิทธิ์) ในหน้านโยบายทั่วไป
- คลิกถัดไป
- ในหน้าการดำเนินการ WSDL ให้เลือก REST ไปยัง SOAP ไปยัง REST
เมื่อคุณเลือกประเภทพร็อกซีแล้ว Edge จะแสดงรายการดำเนินงานที่ ก็จะสร้างเส้นทาง API ของ REST รายการนี้ช่วยให้คุณทำสิ่งต่อไปนี้ได้ เลือกจากการดำเนินการที่พบใน WSDL (ในกรณีที่คุณมี ที่ต้องการ) โปรดสังเกตว่าตารางจะแสดงทรัพยากรที่ ไคลเอ็นต์ REST สามารถใช้เพื่อเรียกใช้บริการ SOAP แบ็กเอนด์ได้
คงการเลือกอื่นๆ ทั้งหมดในหน้าเว็บไว้ตามเดิม
- คลิกถัดไป
- ยอมรับค่าเริ่มต้นของโฮสต์เสมือนโดยคลิกถัดไป
- ในหน้าสรุป ในส่วนการติดตั้งใช้งานที่ไม่บังคับ ให้คลิกทดสอบ แล้วคลิกสร้างและทำให้ใช้งานได้
Edge สร้างพร็อกซี RESTful API และทำให้ใช้งานได้กับสภาพแวดล้อม
test
จาก WSDL จะระบุ การดำเนินการที่รองรับ พารามิเตอร์อินพุต และอื่นๆ Edge แนะนำเมธอด HTTP ที่จะใช้ สำหรับการดำเนินการแต่ละอย่าง โดยปกติแล้ว Edge จะแปลการดำเนินการเป็นคำขอ GET ซึ่งมี ข้อดีของการทำแคชได้ Edge ยังตั้งค่าปลายทางเป้าหมายแบ็กเอนด์ อาจแตกต่างกันไปตามการดำเนินการ SOAPเท่านี้ก็เรียบร้อย เว้นแต่ว่าคุณจะปรับแต่งพร็อกซี API ใหม่ (และไม่ได้อยู่ในบทแนะนำนี้) ก็เรียบร้อย คุณดำเนินการต่อเพื่อทดสอบพร็อกซี API ใหม่ได้
คลาสสิก Edge (Private Cloud)
วิธีการพร็อกซีบริการ SOAP โดยใช้ UI ขอบแบบคลาสสิก มีดังนี้
- ลงชื่อเข้าใช้
http://ms-ip:9000
โดยที่ ms-ip คือ ที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ - เลือก API > พร็อกซี API ในแถบนำทางด้านบน
- คลิก + พร็อกซี API
- คลิกบริการ SOAP
- ในหน้ารายละเอียดพร็อกซี ให้ป้อนข้อมูลต่อไปนี้
ช่อง คำอธิบาย WSDL เลือก URL ตัวอย่าง
จากนั้นเลือกตัวเลือกต่อไปนี้
...delayedstockquote.asmx?WSDLคลิก: ตรวจสอบ
Apigee Edge ได้รับไฟล์ WSDL และอ่านเพื่อค้นหารายการการดำเนินการ ที่บริการ SOAP รองรับ
ชื่อพร็อกซี ป้อน
delayedstockquote
นี่คือชื่อสำหรับพร็อกซีที่คุณกำลังสร้าง
เส้นทางฐานพร็อกซีและคำอธิบาย ปล่อยไว้ตามเดิม - คลิกถัดไป
- ในหน้า WSDL ให้เลือกตัวเลือกต่อไปนี้
ในฟิลด์นี้ สิ่งที่ควรทำ ประเภทพร็อกซี API เลือก: REST ไปยัง SOAP ไปยัง REST
เมื่อคุณเลือกประเภทพร็อกซีแล้ว Edge จะแสดงรายการดำเนินงานที่ ระบบจะสร้างเส้นทาง API ของ REST ดังที่แสดงที่นี่ รายการนี้เป็นโอกาสที่คุณจะ เลือกจากการดำเนินการที่พบใน WSDL (ในกรณีที่คุณมี ที่ต้องการ) โปรดสังเกตว่าตารางจะแสดงทรัพยากรที่ ไคลเอ็นต์ REST สามารถใช้เพื่อเรียกใช้บริการ SOAP แบ็กเอนด์ได้
สำหรับตอนนี้ ให้เลือกการดำเนินการชุดแรกไว้
ประเภทพอร์ต: DelayedStockStockSoap เลือกการดำเนินการ WSDL ทั้ง 3 รายการ ปล่อยการตั้งค่าอื่นๆ ไว้ตามเดิม
- คลิกถัดไป
- ในหน้าความปลอดภัย ให้เลือกผ่าน (ไม่มี)
- คลิกถัดไป
- ยอมรับค่าเริ่มต้นของโฮสต์เสมือน แล้วคลิกถัดไป
- ในหน้าสร้าง ให้ยอมรับค่าเริ่มต้น และคลิกสร้างและทำให้ใช้งานได้เพื่อ
ให้ Edge เริ่มสร้างพร็อกซี
Edge สร้างพร็อกซี RESTful API จาก WSDL จะระบุ การดำเนินการที่รองรับ พารามิเตอร์อินพุต และอื่นๆ Edge แนะนำเมธอด HTTP ที่จะใช้ สำหรับการดำเนินการแต่ละอย่าง โดยปกติแล้ว Edge จะแปลการดำเนินการเป็นคำขอ GET ซึ่งมี ข้อดีของการทำแคชได้ Edge ยังตั้งค่าปลายทางเป้าหมายแบ็กเอนด์ อาจแตกต่างกันไปตามการดำเนินการ SOAP
เท่านี้ก็เรียบร้อย เว้นแต่ว่าคุณจะปรับแต่งพร็อกซีใหม่ (และไม่ได้อยู่ในบทแนะนำนี้) ก็เรียบร้อย คุณสามารถทำการทดสอบพร็อกซีใหม่ได้
กำลังทดสอบพร็อกซี
หากต้องการลองใช้พร็อกซีที่คุณสร้างไว้ ให้เปิด Command Prompt และใช้ cURL พิมพ์คำสั่ง ด้านล่าง โดยที่
- ORG คือชื่อขององค์กร Edge ที่คุณสร้างพร็อกซี
- ENV คือสภาพแวดล้อมที่ทำให้พร็อกซีใช้งานได้
- DOMAIN สอดคล้องกับอินสแตนซ์ Edge ที่คุณใช้อยู่
curl "https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"
ตัวอย่างเช่น หากองค์กรของคุณคือ docfood
สภาพแวดล้อมจะเป็น
test
และหากคุณกำลังใช้ระบบคลาวด์ Edge Enterprise คุณจะเรียกใช้คำสั่ง เช่น
ดังนี้
curl "https://docfood-test.apigee.net/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"
หากคุณป้อน GOOG
สำหรับพารามิเตอร์การค้นหาของ StockSymbol คุณควรเห็น
ราคาปัจจุบันของหุ้น Alphabet Inc. คลาส C เช่น
{ "GetQuoteResponse":{ "GetQuoteResult":{ "StockSymbol":"GOOG", "LastTradeAmount":819.55, "LastTradeDateTime":"2017-02-13T14:33:00", "StockChange":5.88, "OpenAmount":816.0, "DayHigh":820.96, "DayLow":815.49, "StockVolume":785064, "PrevCls":813.67, "ChangePercent":"+0.72%", "FiftyTwoWeekRange":"663.28 - 841.95", "EarnPerShare":27.88, "PE":29.4, "CompanyName":"Alphabet Inc.", "QuoteError":false } } }
รับ OpenAPI ที่สร้างโดยอัตโนมัติ ข้อมูลจำเพาะ
เมื่อคุณพร็อกซีบริการ SOAP โดยใช้ "REST ไปยัง SOAP ไปยัง REST" Edge จะสร้างโดยอัตโนมัติ ข้อกำหนดของ OpenAPI คุณสามารถใช้ ข้อมูลจำเพาะของ OpenAPI เพื่อสร้างเอกสารประกอบ API สำหรับ API
หากต้องการดูข้อกำหนดของ OpenAPI เพียงไปที่ URL นี้
curl https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/openapi.json
เครดิตเพิ่มเติม: How คุณทราบไหมว่าควรใช้ทรัพยากร คำกริยา และพารามิเตอร์การค้นหาใด
ในการเรียก API ทดสอบ คุณใช้ทรัพยากรและพารามิเตอร์การค้นหาในการเรียก cURL ที่เฉพาะเจาะจง ไปยังบริการ SOAP แบ็กเอนด์ แต่คุณจะทราบเรื่องนี้ด้วยตนเองได้อย่างไร
แหล่งข้อมูลและคำกริยา
ในวิซาร์ดพร็อกซี API เมื่อคุณสร้างพร็อกซี คุณเห็นวิธีการทำงานของ SOAP จะจับคู่กับคำกริยาและทรัพยากร API แต่ถ้าคุณไม่ได้เขียนไว้ จะเขียนดังนี้ คุณจะดูได้หลังจากสร้างพร็อกซีแล้ว
ในแท็บพัฒนาของพร็อกซี API ในแผงการนำทางด้านซ้าย คุณจะพบ
รายการโฟลว์ภายใต้ปลายทางของพร็อกซี คลิกขั้นตอนที่คุณสนใจ ตัวอย่างเช่น
ขั้นตอน GetQuote เป็นตัวเลือกที่ดี จากนั้นดู XML ในแผงโค้ด
ซึ่งแสดงเส้นทางทรัพยากรและคำกริยาสำหรับโฟลว์ใน <Condition> องค์ประกอบ:
/quote
และ GET
พารามิเตอร์การค้นหา
เมื่อเลือกขั้นตอนGetQuoteแล้ว ให้คลิกนโยบายแรกในกราฟิก
มุมมองความเคลื่อนไหว ค่านี้ควรเป็นนโยบายการดึงข้อมูลตัวแปรที่บันทึกพารามิเตอร์การค้นหาที่
คาดว่าจะผ่าน: StockSymbol
และ LicenseKey
(หากคุณสร้างเว็บ
ค้นหาบริการ SOAP ระบบจะบอกข้อมูลที่ต้องส่งผ่านสำหรับ LicenseKey)
ระบบจะบันทึกพารามิเตอร์การค้นหาที่บันทึกไว้เป็นตัวแปรและใช้นโยบายถัดไปเพื่อ สร้างข้อความ SOAP