Danh sách mẫu

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu 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ạ 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 các mẫu, hãy xem phần Sử dụng các proxy API mẫu.

Học qua thực hành

Bạn muốn bắt tay vào việc ngay 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 "learn-edge" trong 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 các proxy minh hoạ việc xác thực khoá API, hạn mức, 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 một phút. Và 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. Tệp readme của mỗi mẫu cũng cung cấp cho bạn thông tin tóm tắt ngắn gọn về chức năng của mẫu và cách thiết lập mẫu.

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

Các mẫu sổ tay hướng dẫn về tài liệu

Một bộ mẫu được cung cấp cho các chủ đề về sổ tay 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 các ứ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 một phản hồi phong phú cho ứng dụng khách. (Lưu ý: proxy API này triển khai cùng chức năng với policy-mashup, minh hoạ rằng có thể giải quyết cùng một vấn đề bằng nhiều kỹ thuật khác nhau.)	JavaScript	MashItUp.js
java-hello	Lệnh gọi Java đơn giản "xin chào thế giới".	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ể dùng trong mã Java Callout.	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 2 API công khai, kết hợp các kết quả và tạo một phản hồi phong phú cho ứng dụng khách. (Lưu ý: proxy API này triển khai cùng chức năng với javascript-mashup, minh hoạ rằng có thể giải quyết cùng một vấn đề bằng nhiều kỹ thuật khác nhau.)	AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON	GenerateResponse.js

Các proxy API mẫu

Các proxy API sau đây nằm trong GitHub, nơi các trang tệp 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 xem cột Loại chính sách bên dưới để tìm 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 được liên kết với 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 trong sổ tay về tài liệu và các proxy mẫu trong các bảng ở trên, các mẫu Edge trên GitHub cũng chứa những 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ệ khỏi mối đe doạ bằng biểu thức chính quy có thể bảo vệ các API phụ trợ và vi dịch vụ của bạn khỏi các cuộc tấn công chèn mã 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 loại hình cấp phép Mật khẩu OAuth. Bạn cần xác thực cả khoá và bí mật ứng dụng trên Edge trước khi gọi một Nhà cung cấp dịch vụ danh tính bên ngoài để xác thực thông tin đăng nhập của người dùng.	OAuthV2, các loại khác	Không áp dụng
condition-pattern-matching	Proxy này giú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 một quy trình 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 JavaScript bao gồm từ các tài nguyên JavaScript trong các 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 nhóm 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 hoạt độ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 2 URL và 1 tuyến đường 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 hoạt động Dàn xếp thông tin đăng nhập Kerberos trên Apigee Edge.	JavaCallout	Tệp JAR Java
oauth-advanced	Một ví dụ hoàn chỉnh, hoạt động về quy trình kiểu cấp bằng mã uỷ quyền, với Apigee Edge là máy chủ uỷ quyền.	GenerateAccessToken GenerateAuthCode RefreshAccessToken Nhiều người 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 hoạt động đầy đủ đượ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. 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à bí mật của ứng dụng trước khi gọi một nhà cung cấp dịch vụ danh tính để xác thực thông tin đăng nhập của người dùng trong quy trình loại cấp 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 Quota	không có
oauth10a-3legged	Minh hoạ cấu hình 3 châ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 các tweet. Để làm như vậy, tiện ích 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 chính sách lưu vào bộ nhớ đệm của API Dịch vụ, 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ạ được 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à độ lệch do máy khách 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 phản hồi đó.	Tập lệnh (Python)	setHeader.py
xà phòng	Minh hoạ một phép biến đổi XSL ghi lại một tệp WSDL để phản hồi một yêu cầu bằng tham số truy vấn ?wsdl.	AssignMessage ExtractVariables Script (Python) XSL	calculateaddress.py fixwsdl.xsl
streaming	Minh hoạ cấu hình truyền phát trực tiếp qua HTTP.	không có	không có
target-reroute	Minh hoạ cách sử dụng JavaScript để chọn linh động một URL mục tiêu dựa trên nội dung của một 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 tweet, dẫn đến một dòng thời gian Twitter tinh giản, 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 các phản hồi trên dòng thời gian (ví dụ: từ statuses/user_timeline.json) thành phản hồi oEmbed chứa dữ liệu trên dòng thời gian dưới dạng nội dung HTML đa dạng.	AssignMessage JavaScript	search-oembed.js
biến	Minh hoạ cách trích xuất và đặt các biến dựa trên nội dung thông báo truyền tải, 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	Các tệp lược đồ XML mà bạn có thể dùng làm tài liệu tham khảo khi định cấu hình các 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 một công cụ triển khai (deploy.py) nhập một proxy API vào một tổ chức trên Apigee Edge, sau đó triển khai proxy đó vào môi trường đã chỉ định.
/org-snapshot	Công cụ chụp nhanh 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 của 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à lập trình viên, Apigee-127 sẽ giúp bạn thiết lập và viết mã 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 nhà phát triển Apigee.