自訂協定 API

自訂協定 API 用於管理採用自訂協定的 API。

透過此功能，你可以用統一的方式建立和維護不同類型協定（例如 Thrift、UDP、Kafka、RabbitMQ、RocketMQ 等）的 API 文件，並全部集中在 Apidog 中管理。

就像 HTTP API 文件一樣，自訂協定 API 文件也支援資料夾樹、搜尋與篩選選項、批次管理，以及線上分享，讓團隊更容易協作並對外分享。

建立自訂協定 API

在資料夾樹上方，將滑鼠懸停在 + 圖示上，然後選取 New Other Protocol APIs，並點擊 Other Custom Protocol API。

選取協定類型（選項包括 Thrift、Kafka 等，或點擊 Manage Protocol 以新增自訂協定）。

每個協定都有可用的預設範本。

填寫以下詳細資訊：

URI：端點的唯一 ID，用於將其與其他端點區分開來（類似於 HTTP 端點的 URL 路徑）。

Endpoint Name：端點名稱。

Basic Information：狀態、維護者、標籤及其他詳細資訊。

Documentation Details：允許更靈活地編輯描述、使用說明、範例等內容。

儲存後，你會看到已建立所選協定的端點文件。

自訂協定 API 文件也支援線上分享，讓協作與對外展示更加容易。

你可以複製協作連結，在專案內分享。

你也可以前往 Publish Docs > Quick Share，選取要包含的端點，並選擇是否分享自訂協定 API 文件。