自訂端點欄位

在協作處理 API 時，可能會需要一些自訂的額外欄位來描述端點。例如，你可以新增「需要授權」、「回應格式」或「速率限制政策」等欄位，為使用 API 的使用者提供更多情境資訊。

在 Apidog 中，你可以利用 自訂欄位 來無縫實作這些額外欄位。

設定自訂欄位

你可以在 Apidog 中前往設定 > 一般設定 > 功能設定 > 端點功能設定 來設定端點欄位。你在此處設定的自訂欄位將套用至 Apidog 中的整個專案。

Apidog 提供三個預設的內建欄位，你可以手動啟用或停用。如果啟用，該欄位將顯示在端點中繼資料中。

你也可以依需求彈性新增自訂欄位。

支援的欄位類型：

文字

數字

單選

多選

日期

團隊成員

連結

電子郵件

單一標籤

多個標籤

在 Quick Share 中，你可以選擇是否顯示這些自訂欄位。

在 Apidog 中建立 Quick Share 時，你可以選取 "Show API Fields" 選項，以包含你定義的 API 欄位。

選取要顯示的欄位。

它們將顯示在文件中。

在 Apidog 中發布文件時，你也可以選擇要顯示哪些欄位。在 Publish Docs 區段中，於 Publish Docs Sites > Customize > Appearance & Display Content 下，你可以選取欄位。