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

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

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

Để sử dụng mẫu, bạn cũng phải có:

Công cụ Mô tả
Git Các mẫu 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 GitHub. Nếu không muốn cài đặt Git, bạn có thể duyệt qua các tệp và tải 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 hệ điều hành Linux môi trường này, 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.

Để có được 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. Hãy đảm bảo curl đã được cài đặt và trên đường dẫn của bạn (chạy lệnh which curl để xem đoạn mã đó có trên đường dẫn của bạn hay không) hệ thống của bạn).
dos2unix Nếu đang chạy Cygwin trên Windows, có thể bạn cũng cần có dos2unix tiện ích. (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 API mẫu proxy

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

  1. Sau khi bạn tải 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 của bạn, địa chỉ email được liên kết với tên người dùng của bạn, và môi trường (sản phẩm hoặc thử nghiệm) mà bạn muốn triển khai proxy API.
  4. Sau khi bạn chỉnh sửa setenv.sh, hãy thực thi lệnh 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-4 minutes.) Làm theo lời nhắc để triển khai các sản phẩm, nhà phát triển và ứng dụng API (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 proxy-mẫu. Trong sample-proxies, bạn sẽ tìm thấy một thư mục cho mỗi proxy mẫu. Trong mỗi thư mục là tệp README.md có thông tin về cách chạy mẫu và hai tập lệnh trợ giúp bạn khi thực hiện các thay đổi nhỏ đối với mẫu, triển khai và sau đó gọi mẫu để xem bạn thay đổi có tác động gì:
    • invoke.sh: Thực thi tập lệnh này để gọi phiên bản API đã triển khai proxy.
    • 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.

Gọi proxy API mẫu

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

Từ 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 trong tổ chức của bạn.

Khắc phục sự cố

Để biết thông tin về cách khắc phục sự cố, hãy xem các phần dưới đây:

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 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 những sửa đổi nhỏ, rồi sau đó xem chúng có tác động gì đến thông báo phản hồi.

Để sửa đổi 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 vào 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/, sau đó bạn sửa đổi cấu hình thành 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 proxy API như ví dụ sau đây:

sh deploy.sh

Các proxy API khác có thể được sửa đổi theo cách tương tự để sử dụng chức năng proxy API so với các dịch vụ mục tiêu hiện tại của bạn. 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 thay đổi cấu hình bổ sung.