Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Giới thiệu
Chủ đề này giải thích cách thêm ứng dụng Node.js vào một proxy hiện có trên hệ thống tệp cục bộ của bạn và cách triển khai proxy đó cho Apigee Edge.
Chuẩn bị môi trường phát triển
Trong chủ đề này, chúng tôi giả định rằng bạn đã thiết lập môi trường phát triển proxy trên hệ thống cục bộ và bạn muốn tích hợp ứng dụng Node.js vào môi trường đó.
Cấu trúc cơ bản của một ứng dụng proxy bao gồm ứng dụng Node.js tuân theo mẫu như trong hình dưới đây, với thư mục cơ sở /apiproxy và các thư mục con cho tài nguyên, mục tiêu và proxy. Thư mục apiproxy/resources/node là nơi bạn phải đặt các tệp Node.js. Các thư mục khác chứa các tệp XML xác định điểm cuối proxy và đích, luồng proxy, luồng có điều kiện, v.v. Để biết nội dung mô tả đầy đủ hơn về cấu trúc proxy API, hãy xem tài liệu tham khảo về cấu hình proxy API.
Chỉ cần nhớ rằng mọi mã Node.js thuộc proxy phải được đặt trong /apiproxy/resources/node. Đó là nơi Edge dự kiến sẽ tìm thấy tệp này khi triển khai.
Chỉ định mục tiêu Node.js bằng ScriptTarget
Chìa khoá để tích hợp Node.js vào proxy là chỉ định phần tử <ScriptTarget> trong tệp XML của điểm cuối mục tiêu. Trong cấu trúc tệp proxy, tệp XML này nằm trong apiproxy/targets. Theo mặc định, tên tệp là default.xml.
Để nắm rõ bối cảnh, hãy lưu ý rằng điểm cuối đích thường trỏ đến một dịch vụ phụ trợ thuộc loại nào đó. Trong trường hợp này, chúng ta sẽ truy cập vào dịch vụ mục tiêu mô phỏng Apigee. Định nghĩa điểm cuối mục tiêu sẽ có dạng như sau:
<TargetEndpoint name="default">
<Description/>
<Flows/>
<PreFlow name="PreFlow">
<Request/>
<Response/>
</PreFlow>
<HTTPTargetConnection>
<URL>http://mocktarget.apigee.net/</URL>
</HTTPTargetConnection>
<PostFlow name="PostFlow">
<Request/>
<Response/>
</PostFlow>
</TargetEndpoint>
Phần tử <HTTPTargetConnection> chỉ định URL của dịch vụ phụ trợ, dịch vụ mục tiêu mô phỏng Apigee.
Tuy nhiên, trong trường hợp của Node.js, chính ứng dụng Node.js là mục tiêu. Bạn chỉ định điều này bằng <ScriptTarget> trong tệp apiproxy/targets/default.xml.
Thay vì mục tiêu sử dụng phần tử <HTTPTargetConnection> để chỉ định URL của dịch vụ phụ trợ, ứng dụng Node.js được tham chiếu trực tiếp bằng phần tử <ScriptTarget>, như sau:
<TargetEndpoint name="default"> <ScriptTarget> <ResourceURL>node://server.js</ResourceURL> </ScriptTarget> <PreFlow name="PreFlow"> <Request/> <Response/> </PreFlow> </TargetEndpoint>
Tham số <ResourceURL> phải luôn có tiền tố là node://, sau đó là tên của tập lệnh Node.js chính. Và như đã lưu ý trước đó, tài nguyên Node.js phải nằm trong /apiproxy/resources/node ở phạm vi proxy API.
Bạn có thể đặt các tham số bổ sung trong ScriptTarget. Để biết thông tin chi tiết, hãy xem phần Cấu hình nâng cao của ScriptTarget.
Trong ví dụ này, dưới đây là mã nguồn cho tệp Node.js chính, có tên là server.js. Đây là máy chủ HTTP cơ bản trả về "Hello World!" ("Xin chào thế giới!") khi nhận được yêu cầu:
var http = require('http');
console.log('node.js application starting...');
var svr = http.createServer(function(req, resp) {
resp.end('Hello, Node!');
});
svr.listen(process.env.PORT || 9000, function() {
console.log('Node HTTP server is listening');
});
Tóm lại, giả sử rằng ứng dụng Node.js chính được triển khai trong một tệp có tên là server.js và cấu hình điểm cuối đều có tên là default.xml, thì Proxy API chứa tập lệnh Node.js có cấu trúc như sau:
/apiproxy/proxyName.xml /apiproxy/proxies/default.xml /apiproxy/targets/default.xml /apiproxy/resources/node/server.js
Chuẩn bị triển khai ứng dụng
Hầu hết các ứng dụng Node.js đều có các tệp phần phụ thuộc và bao gồm tệp package.json trong thư mục cơ sở. Trong trường hợp này, tốt nhất bạn nên chạy tiện ích npm để đảm bảo rằng thư mục node_modules cấp cao nhất được điền sẵn các phần phụ thuộc trước khi bạn triển khai. Nếu có bất kỳ phần phụ thuộc từ xa nào không nằm trong node_modules, thì ứng dụng Node.js của bạn sẽ không chạy trên Edge.
Bạn có thể dễ dàng truy xuất tất cả các phần phụ thuộc vào hệ thống tệp của mình bằng cách sử dụng tiện ích npm:
- Từ thư mục cơ sở của ứng dụng Node.js, hãy chạy:
$ npm install
hoặc
$ npm update
Khi các phần phụ thuộc được cài đặt, bạn đã sẵn sàng triển khai proxy cho Edge.
Triển khai ứng dụng Node.js cho Apigee Edge
Trước khi triển khai, bạn cần biết tên tổ chức, tên người dùng và mật khẩu cho tài khoản Apigee Edge. Bạn cần thông tin này để tạo chính xác lệnh công cụ triển khai.
Sau đây là lệnh. Tệp này giả định (với cờ -d) rằng bạn đang ở thư mục gốc của proxy. Nếu proxy của bạn có tên là foo, hãy nhập lệnh sau từ thư mục foo:
$ apigeetool deployproxy -u username -p password -o org -e test -n hellonode -d .Để biết thông tin về ý nghĩa của từng cờ lệnh, hãy làm như sau:
$ apigeetool deployproxy -h
Tóm tắt nhanh:
- -n Cờ này cho phép bạn chỉ định tên của proxy sẽ được tạo khi ứng dụng được triển khai. Bạn sẽ thấy tên này trong giao diện người dùng quản lý.
- -d Chỉ định thư mục gốc của proxy API.
- -o, -e, -u và -p chỉ định tên tổ chức, môi trường triển khai, tên người dùng và mật khẩu.
Kiểm thử proxy API mới
Bạn vừa thêm một ứng dụng Node.js vào một proxy API hiện có và triển khai proxy đó cho Apigee Edge! Để kiểm thử, hãy chạy lệnh cURL sau. Chúng tôi giả định rằng đường dẫn cơ sở mặc định (/) được sử dụng (đường dẫn cơ sở được chỉ định trong tệp cấu hình điểm cuối proxy). Hãy nhớ thay thế tên tổ chức của bạn cho org_name. Nếu chưa cài đặt cURL, bạn có thể nhập URL trong trình duyệt.
$ curl http://org_name-test.apigee.net/
Hello, Node!
Xem proxy mới trong giao diện người dùng quản lý
Đăng nhập vào tài khoản Apigee Edge rồi chuyển đến trang Proxy API. Bạn sẽ thấy proxy có tên "hellonode" được liệt kê ở đó.
Nhấp vào "hellonode" để xem thông tin chi tiết về proxy. Trong chế độ xem Phát triển, bạn có thể xem mã nguồn mà bạn đã tải lên, thêm chính sách, chỉnh sửa quy trình, v.v.
Các bước tiếp theo
Để biết thông tin về cách gỡ lỗi ứng dụng Node.js chạy trên Apigee Edge, hãy xem bài viết Gỡ lỗi và khắc phục sự cố với proxy Node.js.