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

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

ตัวอย่าง API ของ Apigee Edge มีพร็อกซี 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	minimize.js setHeaders.js
javascript-mashup-cookbook	แอปพลิเคชัน JavaScript ที่สมบูรณ์ซึ่งเรียกใช้ API สาธารณะ รวมผลลัพธ์ และ สร้างการตอบกลับที่สมบูรณ์สำหรับแอปไคลเอ็นต์ (หมายเหตุ: พร็อกซี API นี้ใช้ฟังก์ชันการทำงานเดียวกับ การผสมนโยบาย ซึ่งแสดงให้เห็นว่าปัญหาเดียวกันสามารถแก้ไขได้โดยใช้เทคนิคที่แตกต่างกัน)	JavaScript	MashItUp.js
java-hello	การเรียกใช้ Java แบบง่ายๆ ที่แสดงข้อความ "Hello World"	JavaCallout	JavaHello.java
java-cookbook	แปลงเนื้อหาและการตอบกลับส่วนหัวเป็นตัวพิมพ์ใหญ่	JavaCallout	ResponseUppercase.java
java-properties	แสดงวิธีใช้พร็อพเพอร์ตี้ใน Callout ของ Java	JavaCallout	JavaProperties.java
java-error	แสดงรูปแบบการจัดการข้อผิดพลาดที่คุณใช้ในโค้ด Java Callout ได้	JavaCallout	JavaError.java
policy-mashup-cookbook	แอปพลิเคชันที่สมบูรณ์ซึ่งใช้การเขียนนโยบายเพื่อเรียก API สาธารณะ 2 รายการ รวมผลลัพธ์ และสร้างการตอบกลับที่สมบูรณ์สำหรับแอปไคลเอ็นต์ (หมายเหตุ: พร็อกซี API นี้ ใช้ฟังก์ชันการทำงานเดียวกันกับ JavaScript Mashup ซึ่งแสดงให้เห็นว่าปัญหาเดียวกัน สามารถแก้ไขได้โดยใช้เทคนิคที่แตกต่างกัน)	AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON	GenerateResponse.js

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

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

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

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

ชื่อ	คำอธิบาย	ประเภทของนโยบาย	แหล่งข้อมูล
regex-protection	นโยบายการป้องกันภัยคุกคามของนิพจน์ทั่วไปช่วยปกป้อง API แบ็กเอนด์และ ไมโครเซอร์วิสจากการโจมตีแบบ SQL Injection ได้	การปกป้อง นิพจน์ทั่วไป	ไม่มี
oauth-validate-key-secret	คุณกำลังใช้ขั้นตอนประเภทการให้สิทธิ์รหัสผ่าน OAuth คุณต้องตรวจสอบทั้งคีย์ไคลเอ็นต์และข้อมูลลับของแอปพลิเคชันใน Edge ก่อนที่จะเรียกผู้ให้บริการข้อมูลประจำตัวภายนอกเพื่อตรวจสอบข้อมูลเข้าสู่ระบบของผู้ใช้	OAuthV2, อื่นๆ	ไม่มี
condition-pattern-matching	พร็อกซีนี้ช่วยให้คุณลองใช้และทดสอบคำสั่งแบบมีเงื่อนไขในโฟลว์พร็อกซี API ได้อย่างง่ายดาย	AssignMessage	ไม่มี
access-entity	แสดงวิธีดึงข้อมูลโปรไฟล์สำหรับเอนทิตีจากที่เก็บข้อมูล Apigee Edge	AssignMessage AccessEntity ExtractVariables	ไม่มี
apikey	ใช้การตรวจสอบคีย์ API อย่างง่าย	VerifyAPIKey AssignMessage Quota	ไม่มี
async-callout	แสดงการเรียกใช้แบบอะซิงโครนัสอย่างง่ายโดยใช้ httpClient ของ JavaScript	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
conditional-policy	บังคับใช้นโยบายแบบมีเงื่อนไขอย่างง่าย เมื่อคำขอมีส่วนหัว HTTP responsetime:true นโยบายจะเรียกใช้สคริปต์ Python ที่เพิ่มชุดเมตริกประสิทธิภาพ ลงในข้อความตอบกลับเป็นส่วนหัว HTTP	สคริปต์ (Python)	timer.py
dynamic-endpoint	ใช้การกำหนดเส้นทางแบบมีเงื่อนไขอย่างง่ายในสถานการณ์ที่ซับซ้อนขึ้นเล็กน้อย ซึ่งกำหนด URL 2 รายการและเส้นทางเริ่มต้น 1 รายการ	ไม่มี	ไม่มี
jira-release-notes	นี่คือพร็อกซี API ที่ทีมเอกสารของ Apigee ใช้เพื่อสร้างหมายเหตุประจำรุ่นจาก Jira	JSONToXML XSL	releasenotes_api.xsl
kerberos-credential-mediation	ตัวอย่างนี้แสดงวิธีดำเนินการสื่อกลางของข้อมูลเข้าสู่ระบบ Kerberos ใน Apigee Edge	JavaCallout	ไฟล์ JAR ของ Java
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 Quota	ไม่มี
oauth10a-3legged	แสดงการกำหนดค่า OAuth 1.0a แบบ 3 ทาง	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 ตามพารามิเตอร์ limit และ offset ที่ไคลเอ็นต์ระบุ	AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL	paginate.xslt
response-cache	แสดงวิธีแคชพยากรณ์อากาศใน Edge เป็นเวลา 10 นาที	ResponseCache AssignMessage	ไม่มี
simple-python	แสดงสถานการณ์ง่ายๆ ในการแนบสคริปต์ Python ใน การตอบกลับซึ่งจะเพิ่มค่าส่วนหัวลงในการตอบกลับนั้น	สคริปต์ (Python)	setHeader.py
soap	แสดงการแปลง XSL ที่เขียนไฟล์ WSDL ใหม่เพื่อตอบสนองต่อคำขอ ที่มีพารามิเตอร์การค้นหา ?wsdl	AssignMessage ExtractVariables Script (Python) XSL	calculateaddress.py fixwsdl.xsl
สตรีมมิง	แสดงการกำหนดค่าการสตรีม HTTP	ไม่มี	ไม่มี
target-reroute	แสดงการใช้ JavaScript เพื่อเลือก URL เป้าหมายแบบไดนามิกตามเนื้อหา ของข้อความคำขอ	ExtractVariables Javascript	rewriteTargetUrl.js
twitter-mobile-timeline	แสดงวิธีใช้ JavaScript เพื่อนำพารามิเตอร์ที่ไม่จำเป็นออกจากทวีต ซึ่งจะส่งผลให้ไทม์ไลน์ Twitter มีประสิทธิภาพมากขึ้นและเหมาะสำหรับอุปกรณ์เคลื่อนที่ที่มีข้อจำกัดด้านทรัพยากร	AssignMessage Javascript	MobileTimeline.js
twitter-oembed	แปลงการตอบกลับไทม์ไลน์ (เช่น จาก statuses/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 และ Swagger ได้ นอกจากนี้ คุณยังดูตัวอย่าง a127 ได้ที่ GitHub: https://github.com/apigee-127/a127-samples

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

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