Danh sách mẫu

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Các mẫu API Apigee Edge chứa các proxy API, chính sách, mã và công cụ mẫu minh hoạ cho các chức năng của Dịch vụ API Apigee Edge như mô tả bên dưới.

Để biết hướng dẫn về cách sử dụng mẫu, hãy xem phần Sử dụng proxy API mẫu.

Học hỏi bằng thực hành

Bạn muốn nhanh chóng xây dựng nền tảng kiến thức vững chắc về Apigee Edge? Chúng tôi có thư viện mẫu "learn-edge" trên GitHub, cho phép bạn nhanh chóng triển khai, gọi và theo dõi một số proxy mẫu, bắt đầu bằng proxy đơn giản nhất và chuyển sang những proxy minh hoạ phương thức xác thực khoá API, hạn mức, chức năng lưu phản hồi vào bộ nhớ đệm, xử lý lỗi, v.v.

Sau khi sao chép kho lưu trữ và thiết lập môi trường (chỉ mất vài phút), bạn có thể dùng thử từng mẫu trong chưa đầy 1 phút. Vì mỗi mẫu tạo ra một bản sửa đổi mới của cùng một proxy nên môi trường của bạn sẽ không bị lộn xộn với nhiều mẫu. Bạn có thể chuyển đổi các bản sửa đổi, triển khai lại một bản sửa đổi khác trong giao diện người dùng quản lý và xem mã proxy bất cứ lúc nào. Readme cho mỗi mẫu cũng cung cấp cho bạn thông tin tóm tắt về hoạt động của mẫu và cách thiết lập mẫu.

Hãy dùng thử! https://github.com/apigee/api-platform-samples/tree/master/learn-edge

Mẫu sổ tay nấu ăn tài liệu

Chúng tôi cung cấp một loạt mẫu cho các chủ đề sổ tay nấu ăn proxy API.

Tên	Nội dung mô tả	Các Loại Chính sách	Tài nguyên
javascript-cookbook	Minh hoạ một đoạn mã JavaScript đơn giản giúp thêm tiêu đề HTTP từ các biến, chuyển đổi báo cáo thời tiết ở định dạng XML từ JSON sang XML và cắt bớt nội dung cho ứng dụng dành cho thiết bị di động.	JavaScript XMLToJSON	Mini.js setHeaders.js
javascript-mashup-cookbook	Một ứng dụng JavaScript hoàn chỉnh gọi đến các API công khai, kết hợp kết quả và tạo ra phản hồi chi tiết cho ứng dụng khách. (Lưu ý: proxy API này triển khai chức năng giống như kết hợp chính sách, chứng minh rằng có thể giải quyết cùng một vấn đề bằng nhiều kỹ thuật.)	JavaScript	MashItUp.js
java-hello	Chú thích Java (Hello world) đơn giản.	JavaCallout	JavaHello.java
java-cookbook	Chuyển đổi tiêu đề và nội dung phản hồi thành chữ hoa.	JavaCallout	ResponseUppercase.java
java-properties	Minh hoạ cách sử dụng các thuộc tính trong chú thích Java.	JavaCallout	JavaProperties.java
lỗi java	Minh hoạ các mẫu xử lý lỗi mà bạn có thể sử dụng trong mã Chú thích Java.	JavaCallout	JavaError.java
policy-mashup-cookbook	Một ứng dụng hoàn chỉnh dùng cấu trúc chính sách để gọi 2 API công khai, kết hợp kết quả và tạo phản hồi chi tiết cho ứng dụng. (Lưu ý: proxy API này triển khai chức năng giống như trình kết hợp JavaScript, chứng minh rằng có thể giải quyết cùng một vấn đề bằng nhiều kỹ thuật.)	AssignMessage ServiceCallout ExtractVariables JavaScript XMLToJSON	GenerateResponse.js

Proxy API mẫu

Các proxy API sau đây nằm trong GitHub, trong đó các trang readme cung cấp nội dung mô tả chi tiết về các mẫu. Nếu bạn quan tâm đến cách hoạt động của một chính sách cụ thể trong một mẫu, hãy xem cột Loại chính sách bên dưới để biết chính sách mà bạn quan tâm, sau đó nhấp vào tên mẫu trong cột Tên. (Các chính sách này được liên kết đến trang tham khảo tương ứng trong tài liệu.)

Tài liệu tham khảo và công cụ

Ngoài các ví dụ về sổ tay nấu ăn tài liệu và proxy mẫu trong các bảng trên, mẫu GitHub Edge cũng chứa các tài nguyên sau:

Tên	Nội dung mô tả	Các Loại Chính sách	Tài nguyên
rbảo vệ egex	Chính sách bảo vệ khỏi các mối đe doạ sử dụng biểu thức chính quy có thể bảo vệ các API phụ trợ và dịch vụ vi mô khỏi các cuộc tấn công chèn SQL.	Bảo vệ biểu thức chính quy	Không áp dụng
oauth-validate-key-secret	Bạn đang triển khai quy trình cấp loại mật khẩu OAuth. Bạn cần xác thực cả khoá ứng dụng khách của ứng dụng và khoá bí mật trên Edge trước khi gọi một Nhà cung cấp danh tính bên ngoài để xác thực thông tin xác thực của người dùng.	OAuthV2, các ứng dụng khác	Không áp dụng
điều kiện-khớp	Proxy này cho phép bạn dễ dàng dùng thử và kiểm thử các câu lệnh có điều kiện trong quy trình proxy API.	AssignMessage	Không áp dụng
thực thể truy cập	Hướng dẫn cách truy xuất hồ sơ của các thực thể từ kho dữ liệu Apigee Edge.	AssignMessage AccessEntity ExtractVariables	không có
apikey	Triển khai xác thực khoá API đơn giản	VerifyAPIKey AssignMessage Hạn mức	không có
chú thích không đồng bộ	Minh hoạ chú thích không đồng bộ đơn giản bằng cách sử dụng JavaScript httpClient.	JavaScript	lắp ráp_phản hồi.js callout.js
base64encoder	Minh hoạ cách gọi JavaScript bao gồm từ tài nguyên JavaScript trong proxy API.	AssignMessage JavaScript	core-min.js enc-utf16-min.js enc-base64-min.js encryptedAuthHeader.js
chính sách có điều kiện	Triển khai thực thi chính sách có điều kiện đơn giản. Khi một yêu cầu chứa tiêu đề HTTP responsetime:true, chính sách sẽ thực thi tập lệnh Python để thêm một tập hợp chỉ số hiệu suất vào thông báo phản hồi dưới dạng tiêu đề HTTP	Tập lệnh (Python)	timer.py
điểm cuối động	Triển khai định tuyến có điều kiện đơn giản trong một tình huống phức tạp hơn một chút, theo đó xác định 2 URL và 1 tuyến mặc định.	không có	không có
jira-release-notes (ghi chú phát hành của jira)	Đây là proxy API mà nhóm tài liệu Apigee dùng để tạo ghi chú phát hành của Jira.	JSONToXML XSL	releasenotes_api.xsl
kerberos-credential-ication	Mẫu này cho biết cách thực hiện Dàn xếp thông tin xác thực Kerberos trên Apigee Edge.	JavaCallout	Tệp JAR Java
oauth-advanced	Một ví dụ hoàn chỉnh và hoạt động tốt về quy trình cấp mã uỷ quyền, trong đó Apigee Edge là máy chủ uỷ quyền.	GenerateAccessToken GenerateAuthCode RefreshAccessToken Nhiều tệp khác...	xem mã ví dụ
OAuth-client-credentials (Thông tin xác thực khách hàng OAuth)	Minh hoạ điểm cuối của mã thông báo OAuth 2.0 đầy đủ chức năng được định cấu hình cho loại cấp thông tin đăng nhập ứng dụng.	GenerateAccessToken	không có
OAuth-login-app	Không dùng nữa. Thay vào đó, bạn nên xem mẫu oauth-advanced.
oauth-validate-key-secret	Minh hoạ kỹ thuật xác thực khoá và khoá bí mật của ứng dụng trước khi gọi một nhà cung cấp danh tính để xác thực thông tin đăng nhập của người dùng trong quy trình cấp loại mật khẩu.	OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault	không có
OAuth-verify-accesstoken	Hình minh hoạ một proxy API được định cấu hình để xác thực mã truy cập OAuth 2.0 và xác minh Hạn mức.	VerifyAccessToken Hạn mức	không có
OAuth10a-3 Bên	Minh hoạ cấu hình OAuth 1.0a ba chân.	GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken	không có
outbound-oauth	Sử dụng API trình biên dịch Microsoft Azure để dịch tweet. Để thực hiện việc này, trình bổ trợ sẽ thực hiện lệnh gọi đi để lấy mã truy cập OAuth, sau đó lưu mã thông báo vào bộ nhớ đệm bằng chính sách lưu vào bộ nhớ đệm của Dịch vụ API, sử dụng lại mã thông báo đã lưu vào bộ nhớ đệm mỗi khi có cuộc gọi đi. Ngoài ra, còn có một ứng dụng trình duyệt minh hoạ dùng để gọi proxy API.	AssignMessage LookupCache PopulateCache JavaScript	api-config.js api-token-get.js translation-query.js translation-results.js
phân trang	Phân trang một thông báo phản hồi XML dựa trên các tham số giới hạn và chênh lệch do ứng dụng cung cấp	AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL	paginate.xslt
phản hồi-bộ nhớ đệm	Minh hoạ cách lưu dự báo thời tiết vào bộ nhớ đệm trên Edge trong 10 phút.	ResponseCache AssignMessage	không có
simple-python	Minh hoạ một tình huống đơn giản về việc đính kèm một tập lệnh python trong phản hồi để thêm giá trị tiêu đề vào phản hồi đó.	Tập lệnh (Python)	setHeader.py
xà phòng	Minh họa phép chuyển đổi NDK ghi lại tệp WSDL để phản hồi yêu cầu có tham số truy vấn ?wsdl.	AssignMessage ExtractVariables Tập lệnh (Python) XSL	segmentationaddress.py người sửa lỗi
phát trực tuyến	Minh hoạ cấu hình phát trực tuyến HTTP.	không có	không có
định tuyến lại mục tiêu	Minh hoạ việc sử dụng JavaScript để tự động chọn URL mục tiêu dựa trên nội dung của thông báo yêu cầu.	ExtractVariables JavaScript	rewriteTargetUrl.js
twitter-mobile-timeline	Minh hoạ cách sử dụng JavaScript để loại bỏ các tham số không cần thiết khỏi các bài đăng trên Twitter, từ đó rút ra một dòng thời gian đơn giản trên Twitter và thân thiện với các thiết bị di động bị hạn chế về tài nguyên.	AssignMessage JavaScript	MobileTimeline.js
twitter-oembed	Chuyển đổi phản hồi trong dòng thời gian (ví dụ: từ trạng thái/user_timeline.json) thành phản hồi oEmbedding chứa dữ liệu dòng thời gian dưới dạng nội dung HTML đa dạng thức.	AssignMessage JavaScript	search-oembed.js
biến	Minh hoạ cách trích xuất và đặt biến dựa trên nội dung thông báo truyền tải cũng như nội dung thông báo JSON và XML.	AssignMessage ExtractVariables XMLToJSON	minimize.js
xmltojson	Chuyển đổi dữ liệu phản hồi từ XML sang JSON.	XMLToJSON JSONToXML	không có
/schemas	Bạn có thể dùng tệp giản đồ XML mà bạn có thể dùng làm tài liệu tham khảo khi định cấu hình proxy API, chính sách, sản phẩm API cũng như hồ sơ nhà phát triển và ứng dụng.
/tools	Chứa công cụ triển khai triển khai.py sẽ nhập proxy API vào một tổ chức đang sử dụng Apigee Edge, sau đó triển khai nó vào môi trường được chỉ định.
/org-snapshot	Công cụ tổng quan nhanh về tổ chức truy xuất các chế độ cài đặt của tổ chức, bao gồm cả nhà phát triển, sản phẩm API, máy chủ ảo, bản đồ khoá/giá trị, v.v. Bạn có thể dùng công cụ này để sao lưu thông tin chi tiết về một tổ chức hoặc khám phá các chế độ cài đặt trong một tổ chức.

Apigee-127

Nếu bạn là một lập trình viên, Apigee-127 sẽ giúp bạn thiết lập và mã hoá proxy API bằng Node.js và Swagger. Bạn cũng có thể tìm các mẫu a127 trên GitHub: https://github.com/apigee-127/a127-samples.

Chia sẻ trải nghiệm của bạn

Chia sẻ trải nghiệm của bạn trên Diễn đàn nhà phát triển API.