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

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

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

Học bằng cách làm

Bạn muốn bắt tay ngay vào việc và bắt đầu xây dựng một cơ sở kiến thức vững chắc về Apigee Edge? Chúng tôi có một thư viện gồm các mẫu "học nâng cao" 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 từ proxy đơn giản nhất và chuyển sang các proxy minh hoạ việc xác thực khoá API, hạn mức, lưu vào bộ nhớ đệm phản hồi, xử lý lỗi và nhiều tính năng khác.

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ể thử từng mẫu trong dưới một phút. Và vì mỗi mẫu tạo 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 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. Tệp readme cho mỗi mẫu cũng cung cấp cho bạn thông tin tóm tắt ngắn gọn về việc mẫu đang làm gì và cách thiết lập mẫu.

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

Mẫu sổ tay công thức cho tài liệu

Chúng tôi cung cấp một bộ mẫu cho các chủ đề về sách dạy nấu ăn về proxy API.

Tên	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 di động.	JavaScript XMLToJSON	minimize.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 phản hồi phong phú cho ứng dụng khách. (Lưu ý: proxy API này triển khai chức năng giống như chính sách kết hợp, cho thấy rằng bạn 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 đơn giản cho chương trình hello world.	JavaCallout	JavaHello.java
java-cookbook	Chuyển đổi nội dung và tiêu đề 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
java-error	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 sử dụng thành phần chính sách để gọi hai API công khai, kết hợp kết quả và tạo phản hồi phong phú cho ứng dụng khách. (Lưu ý: proxy API này triển khai chức năng tương tự như javascript-mashup, cho thấy rằng cùng một vấn đề có thể được giải quyết 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, nơi 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 một chính sách cụ thể hoạt động trong một mẫu, hãy tìm chính sách bạn quan tâm trong cột Loại chính sách bên dưới, sau đó nhấp vào tên mẫu trong cột Tên. (Các chính sách được liên kết đến các 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 mẫu sách dạy nấu ăn về tài liệu và proxy mẫu trong các bảng ở trên, mẫu GitHub của Edge cũng chứa các tài nguyên sau:

Tên	Mô tả	Các Loại Chính sách	Tài nguyên
regex-protection	Chính sách bảo vệ mối đe doạ biểu thức chính quy có thể bảo vệ các API phụ trợ và dịch vụ vi mô của bạn khỏi các cuộc tấn công chèn SQL.	Bảo vệ bằng 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 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 loại khác	Không áp dụng
condition-pattern-matching	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 luồng proxy API.	AssignMessage	Không áp dụng
access-entity	Cho biết cách truy xuất hồ sơ cho các thực thể từ kho dữ liệu Apigee Edge.	AssignMessage AccessEntity ExtractVariables	không có
apikey	Triển khai quy trình xác thực khoá API đơn giản	VerifyAPIKey AssignMessage Quota	không có
async-callout	Minh hoạ một chú thích không đồng bộ đơn giản bằng cách sử dụng httpClient JavaScript.	JavaScript	assemble_response.js callout.js
base64encoder	Minh hoạ cách gọi các tệp bao gồm JavaScript từ tài nguyên JavaScript trong proxy API.	AssignMessage JavaScript	core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js
conditional-policy	Triển khai biện pháp 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, một chính sách sẽ thực thi một tập lệnh Python để thêm một tập hợp các 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
dynamic-endpoint	Triển khai tính năng đị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, xác định hai URL và một tuyến mặc định.	không có	không có
jira-release-notes	Đây là proxy API mà nhóm tài liệu Apigee sử dụng để tạo ghi chú phát hành từ Jira.	JSONToXML XSL	releasenotes_api.xsl
kerberos-credential-mediation	Mẫu này cho thấy cách thực hiện tính năng Dàn xếp thông tin xác thực Kerberos trên Apigee Edge.	JavaCallout	Tệp JAR Java
oauth-advanced	Ví dụ hoàn chỉnh và hoạt động về quy trình cấp mã uỷ quyền, trong đó Apigee Edge đóng vai trò là máy chủ uỷ quyền.	GenerateAccessToken GenerateAuthCode RefreshAccessToken Và nhiều tính năng khác...	xem mã ví dụ
oauth-client-credentials	Minh hoạ một điểm cuối mã thông báo OAuth 2.0 có đầy đủ chức năng được định cấu hình cho loại cấp thông tin xác thực của ứ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ạ một kỹ thuật xác thực khoá và khoá bí mật của ứng dụng trước khi gọi nhà cung cấp danh tính để xác thực thông tin xác thực 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	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-3legged	Minh hoạ cấu hình ba bên OAuth 1.0a.	GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken	không có
outbound-oauth	Sử dụng API dịch của Microsoft Azure để dịch tweet. Để thực hiện việc này, ứng dụng sẽ thực hiện một 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 cách sử dụng các 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 thực hiện lệnh 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 translate-query.js translate-results.js
phân trang	Phân trang thông báo phản hồi XML dựa trên các tham số giới hạn và độ dời do ứng dụng cung cấp	AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL	paginate.xslt
response-cache	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 tập lệnh python trong phản hồi để thêm giá trị tiêu đề vào tập lệnh đó.	Tập lệnh (Python)	setHeader.py
xà phòng	Minh hoạ một phép biến đổi XSL giúp ghi lại tệp WSDL để phản hồi một yêu cầu bằng tham số truy vấn ?wsdl.	AssignMessage ExtractVariables Tập lệnh (Python) XSL	calculateaddress.py fixwsdl.xsl
phát trực tuyến	Minh hoạ cấu hình truyền trực tuyến HTTP.	không có	không có
target-reroute	Minh hoạ cách sử dụng JavaScript để linh động chọn một 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 thông số không cần thiết khỏi tweet, dẫn đến dòng thời gian Twitter được tinh giản, phù hợp với các thiết bị di động bị hạn chế tài nguyên.	AssignMessage JavaScript	MobileTimeline.js
twitter-oembed	Chuyển đổi các phản hồi dòng thời gian (ví dụ: từ statuses/user_timeline.json) thành phản hồi oEmbed 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 điệp JSON và XML cũng như nội dung thông điệp truyền tải.	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	Các 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, hồ sơ nhà phát triển và ứng dụng.
/tools	Chứa một công cụ triển khai, deploy.py, nhập proxy API vào một tổ chức trên Apigee Edge, sau đó triển khai proxy API đó 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 chế độ cài đặt tổ chức, bao gồm nhà phát triển, sản phẩm API, máy chủ lưu trữ ả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á chế độ cài đặt trong một tổ chức.

Apigee-127

Nếu bạn là lập trình viên, Apigee-127 sẽ giúp bạn bắt đầu và lập trình các proxy API bằng Node.js và Swagger. Bạn cũng có thể tìm thấy 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 dành cho nhà phát triển Apigee.