為什么選擇事件驅(qū)動的 API？

事件驅(qū)動的 API 通過事件實現(xiàn)組件間的實時通信。以下是其核心概念的分解：

• 事件：指系統(tǒng)中狀態(tài)的變化或更新，例如新用戶注冊或支付狀態(tài)更新。在事件驅(qū)動系統(tǒng)中，稱為發(fā)布者（Publisher）的組件將事件發(fā)送到消息代理，消息代理再將事件分發(fā)給所有訂閱該事件的訂閱者（Subscriber）。這種方式使得系統(tǒng)組件無需直接通信即可實現(xiàn)實時交互。

例如，在一個聊天應用中，當用戶發(fā)送消息時，事件驅(qū)動的 API 能立即通知其他用戶，消息會實時顯示在聊天窗口中，而無需刷新頁面。而傳統(tǒng)的同步 API 則需要客戶端頻繁輪詢服務器以檢查新消息。

相比之下，事件驅(qū)動的 API 通過解耦組件，允許發(fā)布者和訂閱者獨立運行，從而實現(xiàn)更高的靈活性和效率。

使用 AsyncAPI 構(gòu)建 Node.js 事件驅(qū)動 API

AsyncAPI 的優(yōu)勢

AsyncAPI 提供了一種標準化的方法來定義事件驅(qū)動 API 的事件、通道和消息格式，使開發(fā)者能夠更輕松地理解和使用這些 API。

在開始實現(xiàn)基于 AsyncAPI 的 Node.js 事件驅(qū)動 API 之前，請確保安裝以下工具和依賴項：

• Node.js 和 npm
• AsyncAPI Generator

安裝完成后，按照以下步驟實現(xiàn)事件驅(qū)動 API。

1. 創(chuàng)建 AsyncAPI 文件

首先，創(chuàng)建一個 AsyncAPI 文件，用于定義事件驅(qū)動系統(tǒng)中的事件及其數(shù)據(jù)結(jié)構(gòu)。AsyncAPI 文件可以使用 YAML 或 JSON 格式編寫，主要包含以下組件：

• asyncapi：指定 AsyncAPI 規(guī)范的版本（例如 v2.6.0）。
• info：包含 API 的元數(shù)據(jù)（如標題、版本、描述等）。
• servers：列出可用的服務器及其協(xié)議配置。
• channels：定義 API 的通道及其操作。
• components：可選部分，用于定義可重用的組件（如消息有效載荷和安全方案）。

以下是一個聊天應用的 AsyncAPI 文件示例：

asyncapi: 2.6.0
info:
  title: 聊天應用程序
  version: 1.0.0
servers:
  test:
    url: test.mosquitto.org:1883
    protocol: mqtt
    description: 測試代理
channels:
  chat:
    publish:
      operationId: onMessageReceived
      message:
        name: text
        payload:
          type: string
    subscribe:
      operationId: sendMessage
      message:
        name: text
        payload:
          type: string

在上述文件中：

• 定義了一個使用 MQTT 協(xié)議的聊天應用程序。
• chat 通道允許客戶端通過 publish 方法發(fā)送消息，并通過 subscribe 方法接收消息。

2. 使用 AsyncAPI 生成器生成應用代碼

安裝 AsyncAPI 生成器：

npm install -g @asyncapi/generator

使用以下命令從 AsyncAPI 文件生成 Node.js 應用代碼：

ag asyncapi.yaml @asyncapi/nodejs-template -p server=test -o example

運行命令后，生成的代碼將包含一個完整的 Node.js 應用程序。接下來，安裝依賴并運行應用程序：

cd example
npm install
npm start

3. 測試 AsyncAPI Node.js 應用程序

要測試應用程序，可以使用 MQTT.js 庫向消息代理發(fā)送消息。首先安裝該庫：

npm install mqtt

然后運行以下命令，通過 chat 通道向測試代理發(fā)送消息：

mqtt pub -t 'chat' -h 'test.mosquitto.org' -m "Hello World"

在運行應用程序的終端窗口中，您應該看到以下輸出：

← 收到聊天："{text: Hello World}"

這表明應用程序已成功接收到消息。您可以在 examples/src/api/handlers/chat.js 中找到消息處理邏輯的代碼模板，并根據(jù)需求實現(xiàn)業(yè)務邏輯。

使用 Bump.sh 管理 AsyncAPI 文件

通過創(chuàng)建 AsyncAPI 文件，實際上您已經(jīng)生成了一個 API 合約。API 合約明確規(guī)定了組件及其行為，例如可用事件、數(shù)據(jù)結(jié)構(gòu)和使用規(guī)則。

使用 Bump.sh，您可以記錄和跟蹤事件驅(qū)動 API 的更改。以下是使用 CLI 上傳 AsyncAPI 文件的步驟：

1. 安裝 Bump CLI：

   npm install -g bump-cli

2. 預覽生成的 API 文檔：

   bump preview path/to/file.json/yml

CLI 將生成一個 URL，您可以通過該 URL 查看 API 文檔的呈現(xiàn)效果。當 AsyncAPI 文件準備好部署時，可以按照 Bump.sh 的指南將文檔上線并共享。

結(jié)論

事件驅(qū)動 API 提供了實時、響應式和松散耦合的系統(tǒng)架構(gòu)，而 AsyncAPI 是定義這些 API 的理想工具。結(jié)合使用 AsyncAPI 和 Bump.sh，您可以為事件驅(qū)動 API 創(chuàng)建高質(zhì)量的文檔，提升開發(fā)和協(xié)作效率。

如果您有任何問題或建議，歡迎隨時與我們聯(lián)系！

原文鏈接: https://bump.sh/blog/asyncapi-first-event-driven-api