Sử dụng mô-đun truy cập API

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ô-đun apigee-access cho phép bạn truy cập vào các biến luồng proxy API và bộ nhớ đệm từ trong mã xử lý ứng dụng Node.js. Mô-đun này đi kèm với nền tảng Apigee Edge; bạn không cần cài đặt mô-đun này giống như các mô-đun Node.js khác.

Nhận quyền truy cập API

Mô-đun apigee-access được tích hợp vào nền tảng Apigee Edge. Khi triển khai mã Node.js cho Edge, bạn sẽ có thể sử dụng mô-đun này. Bạn chỉ cần yêu cầu mã này trong bất kỳ mã Node.js nào mà bạn triển khai. Ví dụ:

var access=require('apigee-access');

Truy cập các biến luồng

Khi triển khai ứng dụng Node.js cho Edge, bạn có thể truy cập vào mọi biến luồng "có sẵn" được hỗ trợ, biến luồng được tạo bởi chính sách và bất kỳ biến luồng nào mà bạn tự tạo trong mã Node.js. Các biến luồng được tạo và tồn tại trong ngữ cảnh của một proxy API chạy trên Edge. Để biết thông tin chi tiết, hãy xem bài viết Truy cập vào các biến luồng trong Node.js.

Truy cập vào bộ nhớ đệm

Mô-đun apigee-access cho phép bạn truy cập vào bộ nhớ đệm phân phối của Apigee Edge từ mã Node.js. Để biết thông tin chi tiết, hãy xem bài viết Truy cập vào bộ nhớ đệm trong Node.js.

Sử dụng dịch vụ hạn mức

Mô-đun apigee-access cho phép bạn truy cập vào dịch vụ hạn mức Apigee Edge từ mã Node.js của bạn. Để biết thông tin chi tiết, hãy xem phần Truy cập vào dịch vụ hạn mức trong Node.js.

Truy cập vào Bản đồ giá trị khoá

Mô-đun apigee-access cho phép bạn truy cập vào bản đồ giá trị khoá (KVM) của Apigee Edge từ mã Node.js. Để biết thông tin chi tiết, hãy xem phần Truy cập vào bản đồ khoá giá trị trong Node.js.

Chạy ở chế độ cục bộ so với chế độ đã triển khai

Để hỗ trợ việc phát triển và kiểm thử cục bộ, mô-đun apigee-access hoạt động ở chế độ cục bộ mà không có phần phụ thuộc trên Apigee Edge. Tuy nhiên, khi mô-đun được dùng với một proxy API được triển khai cho Edge, thì chức năng "cục bộ" sẽ được thay thế bằng chức năng gốc của Edge. Ví dụ: bạn có thể truy cập vào toàn bộ các biến luồng ở chế độ đã triển khai, trong khi chỉ một tập hợp con nhỏ có sẵn khi bạn chạy ứng dụng Node.js cục bộ. Để biết danh sách các biến chế độ cục bộ này, hãy xem phần Chạy ở chế độ cục bộ.

Xác định chế độ mà mô-đun đang chạy

Để xác định chế độ nào bạn đang chạy quyền truy cập API:

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

Giá trị trả về của getMode() cho bạn biết ứng dụng Node.js có được triển khai cho Apigee Edge hay không hoặc đang chạy ở chế độ độc lập. Phương thức này sẽ trả về một trong hai kết quả dạng chuỗi sau:

  • apigee – Ứng dụng Node.js đang chạy trên Apigee Edge và tất cả chức năng đều được hỗ trợ.
  • standalone – Ứng dụng Node.js đang chạy bên ngoài môi trường Apigee Edge và chức năng mặc định được mô tả ở đầu tài liệu này sẽ có hiệu lực.

Chạy ở chế độ đã triển khai

Khi được triển khai lên Edge, các biến do chính sách đặt sẽ hiển thị cho apigee-access, còn các biến được thêm hoặc sửa đổi bằng các phương thức của mô-đun này sẽ hiển thị với các chính sách tiếp theo trong luồng proxy.

Bạn có thể tìm thấy đường liên kết đến các biến được hỗ trợ trong mục Tài liệu tham khảo về biến. Các biến này và mọi biến mà bạn tạo bằng tên riêng của mình sẽ hiển thị với apigee-access. Xin lưu ý rằng một số biến chỉ có thể đọc. Các biến này được xác định trong Tài liệu tham khảo về biến.

Chạy ở chế độ cục bộ

Ở "chế độ cục bộ", bạn đang chạy mã Node.js bên ngoài bối cảnh của Apigee Edge. Ở chế độ này, bạn sẽ không thể truy cập vào hầu hết các biến luồng được xác định trước trong mã Node.js. Bảng này cho thấy một tập hợp con nhỏ các biến luồng có sẵn. Các biến này được hỗ trợ tại đây để hỗ trợ việc phát triển và kiểm thử cục bộ các ứng dụng Node.js cho Apigee Edge.

Biến Chỉ có thể đọc Loại Ghi chú
client.received.start.time Chuỗi Thời gian nhận yêu cầu
client.received.end.time Chuỗi Thời gian nhận yêu cầu
client.received.start.timestamp Số nguyên Thời gian nhận yêu cầu
client.received.end.timestamp Số nguyên Thời gian nhận yêu cầu

Xin nhắc lại rằng trên nền tảng Apigee Edge, chúng tôi hỗ trợ một tập hợp các biến xác định trước lớn hơn nhiều. Hãy tham khảo Tài liệu tham khảo về biến của Apigee Edge để biết danh sách đầy đủ.