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 sẽ cần có 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.

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

Công cụ Nội dung 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 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 phải có Python để chạy công cụ triển khai Apigee. Python có mặt 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 Tập lệnh thiết lập mẫu cũng sử dụng curl. Đảm bảo curl đã được cài đặt và có sẵn trên đường dẫn của bạn (chạy lệnh which curl để xem 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.)

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 mẫu từ dòng lệnh:

  1. Sau khi bạn tải các mẫu xuống, hãy chuyển đến thư mục /setup như 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 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 như sau:
    sh deploy_all.sh

    Tập lệnh này sẽ 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 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 (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 tác động của việc thay đổi:
    • invoke.sh: Thực thi tập lệnh này để gọi phiên bản proxy API đã triển khai.
    • 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 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 các 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 thuộc tổ chức của bạn.

Khắc phục sự cố

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

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

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

Để sửa đổi một proxy API mẫu để 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ó sẵn tại http://api.myproject.com/, bạn sẽ 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:

sh deploy.sh

Bạn có thể sửa đổi các proxy API khác theo cách tương tự để sử dụng chức năng proxy API cho 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 thay đổi cấu hình bổ sung.