Khám phá sức mạnh của API: Tạo API của riêng bạn với n8n
Chúng ta đang sống trong nền kinh tế API. Điều này có ý nghĩa gì đối với các nhà phát triển và cộng đồng n8n? Chà, những kỹ năng như thiết kế API và viết tài liệu hiện đang rất được ưa chuộng. Ngoài ra, các kỹ sư ngày càng dành nhiều thời gian hơn cho việc phát triển và tích hợp API.
Nghiên cứu gần đây của Postman tiết lộ rằng một số công ty mất hơn nửa năm chỉ để đưa API vào vận hành sản xuất. Dữ liệu này nên được xem xét một cách cẩn trọng, vì các loại API khác nhau có yêu cầu hoàn toàn khác nhau.
Nhưng ý tưởng chung là rõ ràng: việc tạo API có thể mất khá nhiều thời gian.
Trong hướng dẫn từng bước này, chúng tôi sẽ hướng dẫn bạn cách xây dựng API và cung cấp một số ví dụ thực tế sử dụng công cụ tự động hóa n8n.
Hãy bắt đầu nào!
Tôi có thể tạo API của riêng mình không?
Chắc chắn rồi! Nếu bạn là một nhà phát triển có kỹ năng biết cách lập trình API bằng ngôn ngữ yêu thích của mình, thì bạn đã có một bước khởi đầu tuyệt vời 🙂
Nhưng này, đôi khi tất cả chúng ta đều cần một chút trợ giúp! Đó là lý do tại sao các công cụ API phù hợp lại rất hữu ích. Người dùng doanh nghiệp có nhiều nền tảng tích hợp API để lựa chọn. Ngoài ra, còn có một số công cụ có thể hỗ trợ trong việc tạo API cho các nhóm nhỏ hoặc thậm chí cho các nhà phát triển độc lập. Dù bạn chọn công cụ nào, vẫn có những nguyên tắc quan trọng để xây dựng một API thành công. Chúng tôi sẽ khám phá những nguyên tắc đó trong phần đầu của hướng dẫn.
Hoặc, bạn có thể sử dụng công cụ tự động hóa n8n. Mặc dù có vẻ nghịch lý, nhưng n8n cho phép bạn tạo ra sản phẩm API của riêng mình và expose nó cho người dùng trong công ty hoặc cho khách hàng bên ngoài. Điểm tuyệt vời nhất của việc sử dụng n8n để xây dựng API là cân bằng hoàn hảo giữa sự đơn giản và linh hoạt. Khám phá chức năng này trong phần hai của bài viết.
Trước khi bắt đầu, đáng để nói rằng có nhiều loại API khác nhau. Trong hướng dẫn này, chúng tôi sẽ tập trung vào API REST.
Làm thế nào để xây dựng một API?
Ngày nay, việc tạo các điểm cuối của API rất dễ dàng. Tuy nhiên, các nhà phát triển API phải xem xét nhiều yếu tố để xây dựng một sản phẩm tốt.
1. Xác định mục tiêu và khách hàng của bạn
Trước tiên, hãy xác định ai là “khách hàng” chính của API và họ cần gì từ sản phẩm của bạn. Nếu bạn đang xây dựng API nội bộ trong công ty, mọi thứ sẽ dễ dàng hơn một chút. Còn đối với khách hàng bên ngoài, bạn có thể cần thực hiện thêm các bước phụ trợ.
API Model Canvas là một khung công cụ hữu ích để lập kế hoạch cho sản phẩm API mới của bạn. Như bạn thấy, có một số khía cạnh cần xem xét:
- Cơ sở hạ tầng và tài nguyên
- Cung cấp API kỹ thuật
- Mối quan hệ với nhà phát triển
- Giá trị so với chi phí
Trong phần này, chúng tôi đặc biệt nhấn mạnh mối quan hệ với nhà phát triển vì các nhà phát triển chính là khách hàng của các sản phẩm API. Tuy nhiên, trong hướng dẫn này, chúng tôi sẽ tập trung nhiều hơn vào các khía cạnh kỹ thuật của việc phát triển API.
2. Thiết kế API
Người dùng của mọi dịch vụ REST API cấu hình một số yếu tố chính để gửi yêu cầu:
- Động từ HTTP (ví dụ: GET, POST, PUT, DELETE)
- Điểm cuối URL. Thường là một danh từ
- Các tham số truy vấn hoặc thân yêu cầu HTTP được truyền vào các điểm cuối API
Việc lập kế hoạch một cấu trúc hợp lý và logic cho sản phẩm API của bạn là rất quan trọng. Lặp lại cùng các khái niệm trong các điểm cuối API khác nhau, để người dùng có thể học nhanh và đoán cách sử dụng ngay cả khi không xem tài liệu.
| Hoạt động | Động từ HTTP | URL: /users | URL: /users/U123 |
|---|---|---|---|
| Tạo | POST | Tạo người dùng mới | Không áp dụng |
| Đọc | GET | Liệt kê tất cả người dùng | Lấy thông tin người dùng U123 |
| Cập nhật | PUT hoặc PATCH | Cập nhật hàng loạt người dùng | Cập nhật người dùng U123 |
| Xóa | DELETE | Xóa tất cả người dùng | Xóa người dùng U123 |
Một ví dụ về các điểm cuối API và các phương thức yêu cầu HTTP. Được tham khảo từ: Designing Web APIs: Building APIs That Developers Love. sách của A. Shevat, B. Jin, và S. Sahni
Tiếp theo, những gì người dùng nhận được chủ yếu phụ thuộc vào nhà phát triển API. Phản hồi mong đợi thường được ghi lại trong tài liệu, nhưng còn mã lỗi thì sao?
Việc lên kế hoạch trước cho các lỗi có thể xảy ra và báo cáo chúng một cách nhất quán là rất quan trọng. Một cách tiếp cận tốt là kết hợp mã lỗi có thể đọc dành cho máy móc với các thông điệp có thể hành động dành cho con người.
| Thể loại lỗi | Trạng thái HTTP | Tiêu đề HTTP | Mã lỗi (đọc được bằng máy) | Mã lỗi (đọc được bằng con người) |
|---|---|---|---|---|
| Lỗi hệ thống | 500 | — | — | — |
| Lỗi logic nghiệp vụ | 429 | Retry-After | rate_limit_exceeded | “Bạn đã vượt quá hạn mức. Xem Retry-After và thử lại.” |
| Lỗi định dạng yêu cầu API | 400 | — | missing_required_parameter | “Yêu cầu của bạn thiếu tham số {user}” |
| Lỗi xác thực | 401 | — | invalid_request | “ClientId của bạn không hợp lệ” |
Một ví dụ về mã lỗi API. Nguồn: như trên
3. Tài liệu & xác định rõ API của bạn
Một số nền tảng API thương mại cung cấp tài liệu API sẵn có ngay trong khuôn khổ. Nếu bạn muốn sử dụng các giải pháp mã nguồn mở, hãy xem tiêu chuẩn OpenAPI và Swagger Editor để tạo tài liệu. Sử dụng JSON schema là một cách khác, tuy nhiên, nó có đường cong học tập dốc hơn cho người mới bắt đầu.
Các công ty hướng tiếp cận API đầu tiên thường bắt đầu việc lập tài liệu API từ sớm. Đây là một phương pháp cực kỳ hữu ích, vì chi phí của những thay đổi sớm trong sản phẩm API thấp hơn nhiều.
4. Phát triển API của bạn
Hơn nữa, các công ty theo hướng API đầu tiên tập trung vào việc xây dựng API ngay cả trước khi phát triển các ứng dụng hoặc tích hợp nền tảng.
Có nhiều cách để tạo API, nhưng hai cách chính là:
- Bắt đầu từ con số không với một ngôn ngữ lập trình nào đó
- Sử dụng công cụ của bên thứ ba
Chúng tôi nghĩ rằng việc sử dụng một công cụ để xây dựng API là một phương pháp tốt hơn vì có nhiều tác vụ điển hình được xử lý bởi một nền tảng API. Việc chọn đúng công cụ là một thử thách riêng và khi làm đúng, điều này giúp tăng tốc đáng kể quy trình.
5. Bảo mật API của bạn
Với sự phong phú của các API ngày nay, chúng thường trở thành mục tiêu của các tác nhân độc hại. Ngay cả khi bạn tạo ra một API sẽ không bao giờ tiếp xúc ra bên ngoài, việc nghĩ về bảo mật API vẫn rất quan trọng. Hãy hình dung một tình huống, khi phần khác bị lỗi và API nội bộ đột nhiên trở nên có sẵn cho tất cả mọi người. Nghe có vẻ đáng sợ phải không?
Có hai chủ đề trong bảo mật API cần nhấn mạnh trong số các chủ đề khác:
- Xác thực. Đây là quá trình xác minh danh tính người dùng. Nó trả lời câu hỏi, “Bạn là ai?” 🕵️♀️ Ví dụ, khi bạn đăng nhập vào một trang web bằng tên người dùng và mật khẩu, hệ thống kiểm tra xem thông tin xác thực có phù hợp với người dùng hợp lệ hay không. Nếu đúng, bạn được xác thực.
- Ủy quyền, ngược lại, liên quan đến việc xác định quyền hạn của người dùng sau khi danh tính của họ đã được xác nhận. Nó trả lời câu hỏi, “Bạn có thể làm gì?” 🚦 Ví dụ, sau khi đăng nhập, người dùng có thể có quyền đọc một số tài liệu nhất định nhưng không thể chỉnh sửa chúng. Đó là mức độ ủy quyền của họ.
6. Thử nghiệm API của bạn
Việc thử nghiệm API là một phần quan trọng trong xây dựng API. Postman, Insomnia và ReadyAPI là những công cụ phổ biến để làm điều đó. Khi thực hiện thử nghiệm đơn giản, bạn có thể sử dụng ReqBin – một dịch vụ web cho phép gửi các yêu cầu đến điểm cuối của API của bạn.
Nếu bạn làm việc trên một dự án lớn hơn, việc triển khai thử nghiệm API tự động là điều cần thiết, đặc biệt khi đến thời điểm nâng cấp API của bạn. Các ca kiểm thử tự động này giúp bạn đảm bảo rằng các tính năng mới không làm hỏng chức năng hiện có.
Phiên bản hóa API là một cách tiếp cận khác. Sử dụng v1/ hoặc v2/ như một phần của URL điểm cuối API giúp duy trì khả năng tương thích ngược của API.
7. Triển khai API của bạn
Khi đã hoàn thành việc tạo API, bạn muốn người dùng bắt đầu tương tác với nó. Theo thời gian, cơ sở người dùng có thể phát triển hoặc API của bạn có thể trải qua các đợt tải đỉnh định kỳ.
Để quản lý thành công điều này, bạn sẽ cần hạ tầng phù hợp. API của bạn sẽ chạy trong đám mây hay tại chỗ?
Ngoài ra, hãy chuẩn bị một bộ công cụ phần mềm hỗ trợ API của bạn để đảm bảo rằng dự án an toàn, hoạt động đúng cách, mở rộng tốt, v.v. Việc xây dựng những công cụ này là một nhiệm vụ cực kỳ phức tạp. Bạn có thể chọn một trong nhiều nền tảng quản lý API có sẵn.
Các nhà cung cấp dịch vụ đám mây như AWS, Google hoặc Azure cung cấp một giải pháp toàn diện để hosting và quản lý API của bạn, tuy nhiên, điều này đi kèm với một khoản phí.
8. Tích hợp API của bạn
API không tồn tại một cách độc lập. Có thể, API mới của bạn cũng sẽ không phải là API đầu tiên được giới thiệu.
Vì vậy, ngay cả trước khi triển khai, việc xem xét cách API bổ sung tích hợp với các ứng dụng, công cụ và API khác là vô cùng quan trọng. Các yếu tố kỹ thuật và tổ chức đều đóng vai trò quyết định thành công của việc tích hợp này.
Ở góc độ kỹ thuật, có nhiều nền tảng tích hợp API có thể hỗ trợ trong lĩnh vực này. Như đã đề cập trước đó, bạn có thể chọn công cụ phù hợp từ một loạt các giải pháp doanh nghiệp hoặc mã nguồn mở.
9. Giám sát API của bạn
Các nền tảng quản lý API thường cung cấp các công cụ giám sát theo thời gian thực. Chúng trực quan hóa luồng ghi nhật ký, tải trọng của máy chủ hiện tại và trình bày thông tin ngắn hạn.
Bên cạnh đó, bạn có thể sử dụng kho lưu trữ nhật ký và kiểm tra nó trên một trong các nền tảng phân tích hoặc trình tạo bảng điều khiển. Chúng tôi đã viết về 8 nền tảng mã nguồn mở low-code tốt nhất, trong đó vài nền phù hợp cho mục đích này. Các trình tạo bảng điều khiển low-code cũng hữu ích cho người dùng phi kỹ thuật để đưa ra quyết định kinh doanh về sản phẩm API.
Cách xây dựng API với n8n?
Bây giờ khi bạn đã quen với các bước quan trọng trong việc tạo API, đã đến lúc bạn tự tạo cho mình một API!
Chúng tôi sẽ sử dụng n8n để trình diễn cách tạo và công khai một điểm cuối API đơn giản chỉ trong vài phút. Ngoài tính đơn giản của quy trình, n8n là một công cụ rất linh hoạt hoạt động hoàn hảo dù bạn là lập trình viên độc lập, làm việc trong nhóm nhỏ hay là thành viên của một doanh nghiệp lớn.
Vì vậy, hãy bắt đầu nào!
Bước 1. Chuẩn bị môi trường n8n của bạn
Bạn có thể sử dụng n8n theo nhiều cách khác nhau: trên đám mây, cài đặt nó trên VPS của bạn, hoặc thậm chí chạy trên máy cục bộ. Chúng tôi đề xuất sử dụng phiên bản đám mây hoặc VPS cho hướng dẫn này. Phiên bản trên máy để bàn cũng hoạt động, nhưng có một số lưu ý nhỏ.
Bước 2. Nhập workflow mẫu
Bắt đầu nhanh với workflow API ví dụ của n8n. Sau khi nhập workflow này, bạn sẽ thấy ba nút kết nối:
- Nút Webhook. Khi kích hoạt, nó sẽ lắng nghe các yêu cầu đến và chuyển dữ liệu đến nút tiếp theo.
- Nút Set tạo chuỗi phản hồi.
- Nút Respond to Webhook gửi phản hồi trở lại người dùng.
Hãy đi sâu vào chi tiết và xem cách hoạt động của từng nút.
Bước 3. Cấu hình Webhook
Khi bạn nhấp đúp vào nút Webhook, một bảng cấu hình sẽ hiện ra:
Bạn có thể thấy năm yếu tố chính của webhook:
- Chế độ Test / Production. Chức năng chuyển đổi này điều chỉnh URL webhook, hãy xem phần webhook-test. Vui lòng nhớ chế độ hoạt động của webhook của bạn để tránh những lỗi không đáng có.
- Xác thực. n8n hỗ trợ xác thực đơn giản và xác thực qua header ngay lập tức. Trong ví dụ này, chúng tôi sẽ tiếp tục không sử dụng xác thực nào cả.
- Phương thức HTTP cũng là một tùy chọn quan trọng và là một nguồn gây nhầm lẫn phổ biến. Chúng tôi khuyên bạn nên đổi tên Webhook để làm rõ phương thức hơn.
- Lựa chọn Path. Đây về cơ bản là một điểm cuối API, một phần của URL nằm sau hostname và
webhook/hoặcwebhook-test/. - Respond là tùy chọn kiểm soát cách webhook phản hồi. Nếu luồng công việc của bạn thực thi một yêu cầu trong thời gian dài hoặc khi người dùng không cần phải chờ đợi phản hồi, bạn có thể đặt chế độ phản hồi ngay lập tức.
Bên cạnh năm trường này, người dùng có thể thêm các tùy chọn khác, chẳng hạn như tiêu đề phản hồi hoặc bỏ qua bot.
Bước 4. Thêm chức năng chính của API
Trong ví dụ đơn giản này, điểm cuối API gửi lại một chuỗi văn bản ngắn. Nhưng bạn có thể thay đổi cách hành xử này và triển khai bất cứ điều gì có thể với n8n! Nhờ tính r extensible của nó, n8n có thể xử lý các nhiệm vụ phức tạp thực sự vượt xa các tích hợp API thông thường.
Bước 5. Cấu hình webhook phản hồi
Chức năng phản hồi của nút webhook cho phép bạn tùy chỉnh phản hồi.
Đầu tiên, bạn có thể chọn Respond With và chọn kiểu dữ liệu là Văn Bản, JSON, nhị phân hoặc không có dữ liệu.
Trong ví dụ của chúng tôi, chúng tôi sử dụng phản hồi dạng văn bản thuần và tạo ra biểu thức chuỗi phản hồi trong trường Response Body.
Bạn cũng có thể cung cấp các trường bổ sung như Response Code hoặc Headers.
Bước 6. Kiểm thử webhook
Khi một điểm cuối API đã sẵn sàng, bạn có thể (và nên!) thử nghiệm nó. Chúng ta sẽ sử dụng ReqBin cho mục đích này.
Trong phần góc trên bên trái của ảnh chụp màn hình, bạn có thể thấy giao diện ReqBin. Tại đây, bạn có thể nhập URL điểm cuối API, chọn phương thức HTTP (trong trường hợp của chúng tôi là GET), cung cấp thông tin xác thực, nội dung thân yêu cầu và một số tiêu đề tùy chọn. Trong ví dụ này, chúng tôi chỉ truyền tham số truy vấn, chúng đã được nhập sẵn vào trường nhập.
Phần góc trên bên phải hiển thị phản hồi của API. Bạn có thể thấy yêu cầu đã thành công (Trạng thái: 200) và nội dung dạng văn bản thuần đã sẵn sàng.
Phần dưới của ảnh chụp màn hình cho thấy cách hoạt động của phía n8n. Phần bên phải của bảng hiển thị các tiêu đề yêu cầu, các tham số đường dẫn API, tham số truy vấn URL và nội dung thân yêu cầu.
Bạn có thể đã nhận thấy rằng các tham số truy vấn URL ?first_name=bob&last_name=marley được lưu dưới khoá JSON query.
Ngoài ra, bạn có thể sử dụng các tham số trong phần Path của nút Webhook. Hãy xem cách chúng được nhận trong trường hợp này:
Cuối cùng, nếu bạn gửi một yêu cầu không hợp lệ (URL không chính xác hoặc phương thức HTTP không được hỗ trợ), bạn sẽ thấy một thông báo lỗi từ n8n. Một số mã lỗi đã được tích hợp sẵn trong nút Webhook. Tuy nhiên, bạn có thể cần xác định thêm các trường hợp khác và tạo một API xử lý các mã lỗi đa dạng hơn.
Tổng kết
Trong hướng dẫn này, chúng tôi đã đề cập đến nhiều bước chính để tạo API và cung cấp một ví dụ sơ bộ trong n8n. Chúng tôi muốn nhấn mạnh một lần nữa rằng việc tạo API rất dễ dàng, nhưng đó vẫn là một chặng đường dài để xây dựng một sản phẩm API thực sự, việc sử dụng n8n để thực hiện công việc này có thể giúp các bạn nhanh chóng kiểm tra được hoạt động của logic. Chúng tôi vẫn khuyến cáo các bạn build API bằng các ngôn ngữ code hoặc framework khác như NodeJS, PHP, Python, C#, Java.
Để tìm hiểu thêm các template N8n, các bạn có thể xem thông tin tại đây
