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

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

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

ดูวิธีการใช้ตัวอย่างได้ที่การใช้พร็อกซี 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	ข้อความไฮไลต์ Hello World ของ Java แบบง่าย	JavaCallout	JavaHello.java
java-cookbook	แปลงเนื้อหาและส่วนหัวของการตอบกลับเป็นตัวพิมพ์ใหญ่	JavaCallout	ResponseUppercase.java
java-properties	สาธิตวิธีใช้พร็อพเพอร์ตี้ในข้อความไฮไลต์ Java	JavaCallout	JavaProperties.java
java-error	แสดงรูปแบบการจัดการข้อผิดพลาดที่คุณใช้ในโค้ดข้อความไฮไลต์ของ Java ได้	JavaCallout	JavaError.java
policy-mashup-cookbook	แอปพลิเคชันที่สมบูรณ์ซึ่งใช้การคอมโพสิชันนโยบายเพื่อเรียก API สาธารณะ 2 รายการ รวมผลลัพธ์ และสร้างการตอบกลับที่สมบูรณ์ยิ่งขึ้นสําหรับแอปไคลเอ็นต์ (หมายเหตุ: พารามิเตอร์ API นี้ใช้ฟังก์ชันการทำงานเดียวกับการรวมข้อมูลแบบ JavaScript ซึ่งแสดงให้เห็นว่าปัญหาเดียวกันนี้สามารถแก้ไขได้โดยใช้เทคนิคที่แตกต่างกัน)	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
สบู่	แสดงการเปลี่ยนรูปแบบ XSL ที่เขียนไฟล์ WSDL ใหม่เพื่อตอบสนองคําขอด้วยพารามิเตอร์การค้นหา ?wsdl	AssignMessage ExtractVariables สคริปต์ (Python) XSL	calculateaddress.py fixwsdl.xsl
streaming	สาธิตการกำหนดค่าสตรีมมิง 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
variables	สาธิตวิธีดึงข้อมูลและตั้งค่าตัวแปรตามเนื้อหาข้อความ 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