8bet

Xây dựng API tùy chỉnh với N8N: Hướng dẫn từng bước

Building Custom APIs with n8n: A Step-by-Step Guide

Written by

admin

in

Hiểu N8N

N8N là một công cụ tự động hóa dòng công việc nguồn mở cho phép người dùng xây dựng API có khả năng tùy biến cao mà không cần kiến ​​thức mã hóa rộng rãi. Nó cung cấp một giao diện trực quan giúp đơn giản hóa các tích hợp dữ liệu phức tạp, cho phép người dùng kết nối các ứng dụng và dịch vụ khác nhau một cách liền mạch. Với N8N, bạn có thể tạo các quy trình công việc tự động hóa các tác vụ lặp đi lặp lại, làm cho các quy trình của bạn hiệu quả hơn.

Bắt đầu với N8N

Để bắt đầu xây dựng API tùy chỉnh với N8N, bạn cần cài đặt nền tảng. N8N có thể được chạy trên các môi trường khác nhau như máy địa phương, Docker hoặc nền tảng đám mây. Với mục đích của hướng dẫn này, chúng tôi sẽ tập trung vào việc sử dụng Docker vì nó cung cấp một thiết lập đơn giản.

  1. Cài đặt Docker: Đảm bảo Docker được cài đặt trên máy của bạn. Bạn có thể tải xuống Docker từ Trang chính thức của Docker.

  2. Chạy N8N:

    Mở thiết bị đầu cuối của bạn và chạy các lệnh sau để đưa N8N lên và chạy:

    docker run -it --rm 
-p 5678:5678 
-e N8N_HOST=localhost 
-e N8N_PORT=5678 
-e N8N_PROTOCOL=http 
n8nio/n8n

    Lệnh này kéo hình ảnh N8N từ Docker Hub và bắt đầu cục bộ. Ứng dụng sẽ có thể truy cập thông qua https://localhost:5678.

Khám phá giao diện N8N

Khi N8N đang chạy, hãy mở trình duyệt web của bạn và điều hướng đến https://localhost:5678. Bạn sẽ hạ cánh trên trình soạn thảo quy trình làm việc N8N.

  • Biên tập viên quy trình làm việc: Đây là không gian làm việc nơi bạn sẽ tạo tự động hóa.
  • Thư viện nút: Ở bên trái, bạn sẽ thấy các nút khác nhau, mỗi nút đại diện cho một dịch vụ hoặc chức năng khác nhau bạn có thể đưa vào quy trình làm việc của mình.
  • Nhật ký thực thi: Phần này cho thấy lịch sử thời gian chạy của quy trình công việc được thực hiện.

Tạo API tùy chỉnh

Để tạo điểm cuối API tùy chỉnh bằng N8N, chúng tôi sẽ tận dụng Webhook Nút, cho phép các hệ thống bên ngoài tương tác với các quy trình công việc N8N.

Bước 1: Thiết lập quy trình làm việc mới

  1. Nhấp vào nút “Mới” để tạo quy trình làm việc mới.
  2. Bạn sẽ thấy một không gian làm việc trống nơi các nút có thể được thêm vào.

Bước 2: Thêm nút Webhook

  1. Tìm kiếm “Webhook” trong thư viện nút và kéo nó lên khung công việc.
  2. Định cấu hình nút:
    • Chọn phương thức HTTP (GET, POST, v.v.).
    • Chỉ định một đường dẫn duy nhất. Ví dụ: nếu URL cơ sở của bạn là https://localhost:5678/webhookđặt đường dẫn làm my-custom-api.

Bước 3: Kiểm tra webhook

  1. Nhấp vào “Thực hiện quy trình công việc”. Hành động này sẽ kích hoạt webhook và bạn sẽ nhận được một URL tạm thời, ví dụ, https://localhost:5678/webhook/my-custom-api.

  2. Sử dụng một công cụ như Postman hoặc Curl để gửi yêu cầu đến điểm cuối mới của bạn:

    curl -X POST https://localhost:5678/webhook/my-custom-api -d '{"key":"value"}'

  3. Kiểm tra nhật ký thực thi để xác minh rằng N8N đã nhận được yêu cầu.

Xử lý dữ liệu trong quy trình công việc

Khi webhook thu thập dữ liệu, bạn có thể muốn xử lý nó cho các mục đích sử dụng khác nhau, chẳng hạn như gửi thông báo, lưu vào cơ sở dữ liệu hoặc chuyển đổi dữ liệu. Đây là cách làm điều đó:

Bước 4: Thêm nút chức năng

  1. Sau nút webhook, thêm một Function nút để xử lý dữ liệu đến.
  2. Trên nút chức năng, bạn có thể viết JavaScript để thao tác dữ liệu. Ví dụ: 
    items[0].json.result = items[0].json.key.toUpperCase();
return items;

Bước 5: Trả lời cuộc gọi Webhook

Để gửi phản hồi lại cho người yêu cầu, bạn có thể sử dụng Respond to Webhook nút.

  1. Tìm kiếm "Respond to Webhook" và thêm nó vào quy trình làm việc.

  2. Kết nối đầu ra của Function nút cho nút mới này.

  3. Tùy chỉnh phản hồi: Bạn có thể muốn gửi lại dữ liệu đã xử lý. Trong cài đặt nút, bạn có thể ánh xạ các trường trả về:

    {
   "result": "={{$json.result}}"
}

  4. Nhấp vào “Thực thi quy trình công việc” một lần nữa để kiểm tra toàn bộ luồng.

Xử lý lỗi và gỡ lỗi

Khi xây dựng API, xử lý lỗi là rất quan trọng để đảm bảo độ tin cậy của ứng dụng của bạn.

Bước 6: Thực hiện xử lý lỗi

  1. N8N cung cấp quy trình công việc lỗi tích hợp. Sử dụng nó bằng cách thêm một If Nút giữa các bước để kiểm tra các điều kiện (ví dụ, cho dù có trường cần thiết).
  2. Nếu điều kiện đánh giá là sai, bạn có thể thiết lập một Set nút để chuẩn bị phản hồi lỗi.

Ví dụ: nếu yêu cầu key bị thiếu:

if (!items[0].json.key) {
    return [{json: {error: 'Missing key.'}}];
}

Thực tiễn tốt nhất để xây dựng API N8N

  1. Kiểm soát phiên bản: Theo dõi quy trình công việc của bạn trong GIT. Khi thực hiện các thay đổi đáng kể, hãy đảm bảo lưu các phiên bản của quy trình công việc của bạn.

  2. Tài liệu: Tài liệu cho mỗi điểm cuối API, định dạng đầu vào dự kiến ​​và cấu trúc phản hồi. Điều này sẽ giúp các nhà phát triển khác hoặc tương lai bạn dễ dàng hơn.

  3. Kiểm tra: Sử dụng các công cụ như Postman để liên tục kiểm tra các điểm cuối của bạn khi bạn phát triển.

  4. Các biện pháp bảo mật: Thực hiện xác thực và ủy quyền. Bạn có thể sử dụng quản lý thông tin xác thực của N8N để xử lý các khóa API và bí mật một cách an toàn.

  5. Tối ưu hóa hiệu suất: Giảm chi phí bằng cách giảm thiểu số lượng nút nếu có thể và tránh các cuộc gọi đồng bộ phức tạp có thể làm chậm thời gian phản hồi.

  6. Khả năng mở rộng: Xem xét việc triển khai N8N của bạn. Đối với các hoạt động lớn hơn, hãy xem xét sử dụng nó trên nhà cung cấp đám mây có giới hạn tài nguyên cao hơn.

Tích hợp với cơ sở dữ liệu

Đối với nhiều ứng dụng, bạn sẽ cần tích hợp với cơ sở dữ liệu. N8N hỗ trợ một số cơ sở dữ liệu, bao gồm MySQL, PostgreSQL, v.v.

Bước 7: Thêm nút cơ sở dữ liệu

  1. Tìm kiếm nút cơ sở dữ liệu mong muốn của bạn và thêm nó vào khung vẽ của bạn (ví dụ: MySQL).

  2. Chỉ định thông tin đăng nhập cơ sở dữ liệu của bạn trong cài đặt của nút.

  3. Sử dụng truy vấn SQL để chèn hoặc truy xuất dữ liệu. Ví dụ: để chèn dữ liệu:

    INSERT INTO my_table (key_column) VALUES ({{ $json.key }});

Giám sát và mở rộng quy trình công việc N8N

Sau khi quy trình làm việc của bạn là trực tiếp, giám sát là điều cần thiết.

  1. Bật ghi nhật ký: Sử dụng nhật ký tích hợp của N8N để hiểu các vấn đề về hiệu suất và khắc phục sự cố.
  2. Cảnh báo thiết lập: Xem xét việc thiết lập cảnh báo cho các thực thi không thành công. Bạn có thể làm điều này qua email hoặc thông báo chùng.
  3. Triển khai đám mây: Để mở rộng quy mô, hãy xem xét sử dụng các dịch vụ đám mây N8N cung cấp hiệu suất tốt hơn, đặc biệt là dưới tải.

Kết luận thực hiện quy trình

Bằng cách làm theo các bước được nêu, bạn đã xây dựng thành công API tùy chỉnh bằng N8N. Trình tạo quy trình công việc trực quan không chỉ đơn giản hóa quá trình tự động hóa mà còn cung cấp sự linh hoạt để mở rộng các chức năng một cách dễ dàng. Bây giờ bạn có kiến ​​trúc cơ bản tại chỗ, bạn có thể tăng cường hơn nữa API của mình với nhiều nút hơn, chức năng nâng cao và tích hợp phù hợp với nhu cầu dự án của bạn.