Sử dụng proxy API 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

Điều kiện tiên quyết

Bạn sẽ cần có một tài khoản trên http://enterprise.apigee.com. Bạn có thể đăng ký tài khoản dùng thử tại http://accounts.apigee.com/accounts/sign_up.

Để sử dụng mẫu, bạn cũng phải có những điều kiện sau:

Công cụ Mô tả
Git Các mẫu này nằm trên GitHub. Nếu bạn chưa cài đặt Git, vui lòng tham khảo hướng dẫn thiết lập git của GitHub. Nếu không muốn cài đặt Git, bạn có thể duyệt xem các tệp và tải một tệp ZIP xuống từ https://github.com/apigee/api-platform-samples.
Python

Bạn cần có Python để chạy công cụ triển khai Apigee. Python có trong hầu hết các môi trường Linux, trên máy Mac đã cài đặt XCode, trên máy Windows đã cài đặt Cygwin và ở nhiều nơi khác.

Để tải Python, vui lòng tham khảo trang tải Python xuống.

curl Các tập lệnh thiết lập mẫu cũng sử dụng curl. Đảm bảo bạn đã cài đặt curl và có sẵn trên đường dẫn của bạn (chạy lệnh which curl để xem liệu lệnh này có sẵn trên hệ thống của bạn hay không).
dos2unix Nếu đang chạy Cygwin trên Windows, bạn cũng có thể cần đến tiện ích dos2unix. (Trình cài đặt Cygwin cho phép bạn cài đặt tiện ích này.)

Tải mẫu xuống

Để lấy các tệp mẫu, hãy sử dụng git clone như ví dụ sau:

git clone https://github.com/apigee/api-platform-samples.git

Nhập và triển khai các proxy API mẫu

Nhập và triển khai các mẫu từ dòng lệnh:

  1. Sau khi tải các mẫu xuống, hãy chuyển đến thư mục /setup, như trong ví dụ sau:
    cd setup
  2. Trong thư mục /setup, hãy tìm tệp setenv.sh.
  3. Chỉnh sửa tệp này để thiết lập tổ chức, địa chỉ email được liên kết với tên người dùng và môi trường (prod hoặc test) mà bạn muốn triển khai các proxy API.
  4. Sau khi chỉnh sửa setenv.sh, hãy thực hiện những thao tác sau:
    sh deploy_all.sh

    Tập lệnh này triển khai tất cả các mẫu proxy API cho tổ chức của bạn. (Quá trình này mất 3 đến 4 phút.) Làm theo lời nhắc để triển khai các sản phẩm API, nhà phát triển và ứng dụng (được dùng cho OAuth).

  5. Sau khi tập lệnh triển khai hoàn tất, hãy chuyển đến thư mục sample-proxies. Trong thư mục sample-proxies, bạn sẽ thấy một thư mục cho mỗi proxy mẫu. Trong mỗi thư mục là một tệp README.md chứa thông tin về cách chạy mẫu và 2 tập lệnh giúp bạn thực hiện các thay đổi nhỏ đối với mẫu, triển khai rồi gọi mẫu để xem thay đổi của bạn có hiệu ứng gì:
    • invoke.sh: Thực thi tập lệnh này để gọi phiên bản đã triển khai của proxy API.
    • deploy.sh: Thực thi tập lệnh này để triển khai proxy API sau khi bạn thực hiện bất kỳ thay đổi nào.

Gọi các proxy API mẫu

Mỗi proxy mẫu đều có một tập lệnh shell liên kết mà bạn có thể dùng để gọi proxy API sau khi triển khai.

Trong thư mục /sample-proxies/proxy_name, hãy thực thi lệnh sau:

sh invoke.sh

Thao tác này sẽ gọi proxy đang chạy trong môi trường thử nghiệm của tổ chức bạn.

Khắc phục sự cố

Để biết thông tin khắc phục sự cố, hãy xem phần sau:

Sửa đổi và sử dụng lại các proxy API mẫu

Cách sử dụng điển hình của các proxy mẫu là sửa đổi, triển khai và gọi. Điều này cho phép bạn thực hiện các sửa đổi nhỏ, sau đó xem những sửa đổi đó có ảnh hưởng gì đến thông báo phản hồi.

Để sửa đổi một proxy API mẫu nhằm trỏ đến một dịch vụ phụ trợ khác, hãy sửa đổi tệp cấu hình XML ở vị trí sau:

/apiproxy/targets/target_name.xml

Ví dụ: để trỏ mẫu khoá API đến dịch vụ phụ trợ của riêng bạn, hãy tìm tệp này:

/apikey/apiproxy/targets/default.xml

Nếu cấu hình mặc định trỏ đến http://mocktarget.apigee.net, chẳng hạn như:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

và dịch vụ phụ trợ của bạn có tại http://api.myproject.com/, thì bạn có thể sửa đổi cấu hình để có dạng như sau:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

Sau khi bạn lưu các thay đổi, hãy triển khai API proxy như ví dụ sau:

sh deploy.sh

Bạn có thể sửa đổi các API proxy khác theo cách tương tự để sử dụng chức năng API proxy đối với các dịch vụ mục tiêu hiện có. Tuy nhiên, trong một số trường hợp, hành vi của proxy API phụ thuộc vào các định dạng thông báo cụ thể, vì vậy, các proxy có thể cần thêm các thay đổi về cấu hình.