รายการตัวอย่าง

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

ตัวอย่าง Apigee Edge API ประกอบไปด้วยตัวอย่างพร็อกซี นโยบาย โค้ด และเครื่องมือของ API ที่แสดงให้เห็นความสามารถของบริการ API ของ Apigee Edge ดังที่อธิบายด้านล่าง

สำหรับวิธีการใช้ตัวอย่าง โปรดดูที่การใช้พร็อกซี API ตัวอย่าง

เรียนรู้จากการลงมือทำ

อยากลดความยุ่งยากและเริ่มต้นสร้างฐานความรู้ที่แข็งแกร่งเกี่ยวกับ Apigee Edge ไหม เรามีไลบรารีตัวอย่าง "learn-edge" ใน GitHub ที่ให้คุณทำให้พร็อกซีตัวอย่างใช้งานได้ เรียกใช้ และติดตามตัวอย่างพร็อกซีได้อย่างรวดเร็ว โดยเริ่มจากพร็อกซีที่ง่ายที่สุดและเปลี่ยนไปใช้พร็อกซีที่แสดงให้เห็นการตรวจสอบคีย์ API, โควต้า, การแคชการตอบกลับ, การจัดการข้อผิดพลาด และอื่นๆ

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

ลองดูเลย https://github.com/apigee/api-platform-samples/tree/master/learn-edge

ตัวอย่างตำราอาหารในเอกสาร

มีชุดตัวอย่างสำหรับหัวข้อตำราอาหารของพร็อกซี API

ชื่อ	คำอธิบาย	ประเภทของนโยบาย	แหล่งข้อมูล
javascript-cookbook	แสดงข้อมูลโค้ด JavaScript แบบง่ายๆ ที่เพิ่มส่วนหัว HTTP จากตัวแปร เปลี่ยนรูปแบบรายงานสภาพอากาศในรูปแบบ XML จาก JSON เป็น XML และตัดเนื้อหาสำหรับไคลเอ็นต์บนอุปกรณ์เคลื่อนที่	JavaScript XMLToJSON	less.js setHeaders.js
javascript-mashup-cookbook	แอปพลิเคชัน JavaScript ที่สมบูรณ์ซึ่งเรียกใช้ API สาธารณะ รวมผลลัพธ์ และสร้างการตอบสนองที่สมบูรณ์ขึ้นสำหรับแอปไคลเอ็นต์ (หมายเหตุ: พร็อกซี API นี้ใช้ฟังก์ชันเดียวกันกับนโยบายผสม ซึ่งแสดงให้เห็นว่าปัญหาเดียวกันนั้นจัดการได้ด้วยเทคนิคที่ต่างกัน)	JavaScript	MashItUp.js
java-hello	ข้อความไฮไลต์ Java ธรรมดาๆ	JavaCallout	JavaHello.java
java-cookbook	แปลงเนื้อหาของการตอบกลับและส่วนหัวเป็นตัวพิมพ์ใหญ่	JavaCallout	ResponseUppercase.java
java-properties	สาธิตวิธีใช้พร็อพเพอร์ตี้ในข้อความไฮไลต์ Java	JavaCallout	JavaProperties.java
ข้อผิดพลาด Java	แสดงรูปแบบการจัดการข้อผิดพลาดที่คุณสามารถใช้ในโค้ดการเรียก Java	JavaCallout	JavaError.java
ตำราอาหารผสมกับนโยบาย	แอปพลิเคชันแบบสมบูรณ์ที่ใช้องค์ประกอบของนโยบายเพื่อเรียกใช้ API สาธารณะ 2 รายการ รวมผลลัพธ์ และสร้างการตอบสนองที่สมบูรณ์ขึ้นสำหรับแอปไคลเอ็นต์ (หมายเหตุ: พร็อกซี API นี้ใช้ฟังก์ชันเดียวกันกับ javascript-mashup ซึ่งแสดงให้เห็นว่าสามารถแก้ปัญหาเดียวกันได้โดยใช้เทคนิคที่ต่างกัน)	AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON	GenerateResponse.js

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

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

ข้อมูลอ้างอิงและเครื่องมือ

นอกเหนือจากตัวอย่างตำราอาหารในเอกสารและพร็อกซีตัวอย่างในตารางด้านบนแล้ว ตัวอย่าง Edge GitHub ยังมีแหล่งข้อมูลต่อไปนี้อีกด้วย

ชื่อ	คำอธิบาย	ประเภทของนโยบาย	แหล่งข้อมูล
regex-protection	นโยบายป้องกันภัยคุกคามของนิพจน์ทั่วไปจะปกป้อง API แบ็กเอนด์และ Microservice จากการโจมตีการแทรก SQL	การป้องกันนิพจน์ทั่วไป	ไม่มีข้อมูล
oauth-validate-key-secret	คุณกำลังใช้ขั้นตอนประเภทการให้สิทธิ์รหัสผ่าน OAuth คุณต้องตรวจสอบทั้งคีย์และรหัสลับไคลเอ็นต์ของแอปพลิเคชันใน Edge ก่อนจะเรียกใช้ผู้ให้บริการข้อมูลประจำตัวภายนอกเพื่อตรวจสอบข้อมูลเข้าสู่ระบบของผู้ใช้	OAuthV2 และอื่นๆ	ไม่มีข้อมูล
การจับคู่รูปแบบเงื่อนไข	พร็อกซีนี้ช่วยให้คุณลองใช้และทดสอบคำสั่งแบบมีเงื่อนไขในขั้นตอนพร็อกซี API ได้อย่างง่ายดาย	AssignMessage	ไม่มีข้อมูล
เอนทิตีการเข้าถึง	แสดงวิธีเรียกข้อมูลโปรไฟล์สำหรับเอนทิตีจากพื้นที่เก็บข้อมูล Apigee Edge	AssignMessage AccessEntity ExtractVariables	ไม่มี
apikey	ใช้การตรวจสอบคีย์ API แบบง่าย	VerifyAPIKey AssignMessage โควต้า	ไม่มี
ข้อความไฮไลต์แบบไม่พร้อมกัน	แสดงการเรียกแบบอะซิงโครนัสอย่างง่ายโดยใช้ JavaScript httpClient	JavaScript	assemble_response.js callout.js
base64encoder	สาธิตวิธีเรียก JavaScript จากแหล่งข้อมูล JavaScript ในพร็อกซี API	AssignMessage JavaScript	Core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js
นโยบายแบบมีเงื่อนไข	ใช้การบังคับใช้นโยบายแบบมีเงื่อนไขอย่างง่าย เมื่อคำขอมีส่วนหัว HTTP Responsetime:true นโยบายจะเรียกใช้สคริปต์ Python ที่เพิ่มชุดเมตริกประสิทธิภาพลงในข้อความตอบกลับ เป็นส่วนหัว HTTP	สคริปต์ (Python)	timer.py
ปลายทางแบบไดนามิก	ใช้การกำหนดเส้นทางแบบมีเงื่อนไขแบบง่ายในสถานการณ์ที่ซับซ้อนขึ้นเล็กน้อย ซึ่งจะกำหนด URL 2 รายการและเส้นทางเริ่มต้น 1 รายการ	ไม่มี	ไม่มี
jira-release-note	นี่คือพร็อกซี API ที่ทีมเอกสารของ Apigee ใช้ในการสร้างบันทึกประจำรุ่นจาก Jira	JSONToXML XSL	releasenotes_api.xsl
Kerberos-credential-Mediation	ตัวอย่างนี้แสดงวิธีดำเนินการสื่อกลางข้อมูลเข้าสู่ระบบ Kerberos ใน Apigee Edge	JavaCallout	ไฟล์ Java JAR
oauth-advanced	ตัวอย่างที่สมบูรณ์และใช้งานได้ของโฟลว์ประเภทการให้สิทธิ์รหัสการให้สิทธิ์ โดยมี Apigee Edge เป็นเซิร์ฟเวอร์การให้สิทธิ์	GenerateAccessToken GenerateAuthCode RefreshAccessToken อื่นๆ อีกมากมาย...	ดูโค้ดตัวอย่าง
oauth-client-credentials	แสดงปลายทางของโทเค็น OAuth 2.0 ที่ทำงานได้เต็มรูปแบบซึ่งกำหนดค่าสำหรับประเภทการให้สิทธิ์ข้อมูลเข้าสู่ระบบไคลเอ็นต์	GenerateAccessToken	ไม่มี
oauth-login-app	เลิกใช้งานแล้ว เราขอแนะนำให้ดูตัวอย่าง oauth-advanced แทน
oauth-validate-key-secret	แสดงเทคนิคการตรวจสอบคีย์และข้อมูลลับของไคลเอ็นต์ก่อนเรียกใช้ผู้ให้บริการข้อมูลประจำตัวเพื่อตรวจสอบข้อมูลเข้าสู่ระบบของผู้ใช้ในขั้นตอนประเภทการให้สิทธิ์รหัสผ่าน	OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault	ไม่มี
oauth-verify-accesstoken	แสดงพร็อกซี API ที่กำหนดค่าเพื่อตรวจสอบโทเค็นเพื่อการเข้าถึง OAuth 2.0 และยืนยันโควต้า	VerifyAccessToken โควต้า	ไม่มี
oauth10a-3leged	แสดงการกำหนดค่าแบบ 3 ทาง OAuth 1.0a	GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken	ไม่มี
outbound-oauth	ใช้ Microsoft Azure translator API เพื่อแปลทวีต ในการดำเนินการดังกล่าว ระบบจะทำการเรียกออกเพื่อรับโทเค็นเพื่อการเข้าถึง OAuth จากนั้นแคชโทเค็นโดยใช้นโยบายการแคชของบริการ API โดยนำโทเค็นที่แคชไว้มาใช้ซ้ำทุกครั้งที่มีการโทรออก นอกจากนี้ยังมีแอปเบราว์เซอร์สาธิตที่ใช้เพื่อเรียกใช้พร็อกซี API	AssignMessage LookupCache PopulateCache JavaScript	api-config.js api-token-get.js translate-query.js translate-results.js
การใส่เลขหน้า	ใส่เลขหน้าของข้อความตอบกลับ XML ตามพารามิเตอร์ขีดจำกัดและออฟเซ็ตที่ไคลเอ็นต์ระบุ	AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL	paginate.xslt
แคชการตอบสนอง	แสดงวิธีแคชการพยากรณ์อากาศบน Edge เป็นเวลา 10 นาที	ResponseCache AssignMessage	ไม่มี
simple-python	แสดงสถานการณ์ง่ายๆ ของการแนบสคริปต์ Python ใน การตอบสนองที่เพิ่มค่าส่วนหัวให้กับสคริปต์นี้	สคริปต์ (Python)	setHeader.py
สบู่	แสดงการเปลี่ยนรูปแบบ XSL ที่เขียนไฟล์ WSDL ใหม่เพื่อตอบสนองคำขอด้วยพารามิเตอร์การค้นหา ?wsdl	AssignMessage ExtractVariables สคริปต์ (Python) XSL	Computeaddress.py fixwsdl.xsl
สตรีมมิง	แสดงการกำหนดค่าสตรีมมิง HTTP	ไม่มี	ไม่มี
เปลี่ยนเส้นทางเป้าหมาย	แสดงการใช้ JavaScript เพื่อเลือก URL เป้าหมายแบบไดนามิกตามเนื้อหาของข้อความคำขอ	ExtractVariables JavaScript	rewriteTargetUrl.js
ไทม์ไลน์ Twitter-mobile	สาธิตวิธีใช้ JavaScript เพื่อตัดพารามิเตอร์ที่ไม่จำเป็นออกจากทวีต ทำให้มีไทม์ไลน์ใน Twitter ที่เหมาะสม เหมาะสำหรับอุปกรณ์เคลื่อนที่ที่มีทรัพยากรจำกัด	AssignMessage JavaScript	MobileTimeline.js
Twitter-Oembed	เปลี่ยนการตอบกลับในไทม์ไลน์ (เช่น จาก status/user_timeline.json) เป็นการตอบกลับ oEmbed ที่มีข้อมูลไทม์ไลน์เป็นเนื้อหา HTML ที่สมบูรณ์	AssignMessage JavaScript	search-oembed.js
ตัวแปร	สาธิตวิธีแยกและตั้งค่าตัวแปรตามการนำส่งเนื้อหาข้อความ JSON และ XML	AssignMessage ExtractVariables XMLToJSON	minimize.js
xmltojson	แปลงข้อมูลการตอบกลับจาก XML เป็น JSON	XMLToJSON JSONToXML	ไม่มี
/schemas	ไฟล์สคีมา XML ที่คุณใช้เป็นข้อมูลอ้างอิงเมื่อกำหนดค่าพร็อกซี API, นโยบาย, ผลิตภัณฑ์ API และโปรไฟล์นักพัฒนาแอปและโปรไฟล์แอปได้
/tools	มีเครื่องมือการทำให้ใช้งานได้ ชื่อDeploy.py ซึ่งนำเข้าพร็อกซี API ไปยังองค์กรใน Apigee Edge แล้วทำให้ใช้งานได้กับสภาพแวดล้อมที่ระบุ
/org-snapshot	เครื่องมือภาพรวมองค์กรจะเรียกการตั้งค่าองค์กร รวมถึงนักพัฒนาซอฟต์แวร์, ผลิตภัณฑ์ API, โฮสต์เสมือน, แมปคีย์/ค่า ฯลฯ เครื่องมือดังกล่าวใช้เพื่อสำรองข้อมูลรายละเอียดขององค์กรหรือค้นหาการตั้งค่าในองค์กรได้

Apigee-127

หากคุณเป็นนักเขียนโค้ด Apigee-127 ก็จะช่วยคุณเขียนโค้ดพร็อกซี API ด้วย Node.js และ Swคนหนึ่ง และคุณยังดูตัวอย่าง a127 ใน GitHub ได้ที่ https://github.com/apigee-127/a127-samples

แชร์ประสบการณ์ของคุณ

แชร์ประสบการณ์ของคุณในฟอรัมนักพัฒนาซอฟต์แวร์ Apigee