我們之前說過，而且我們會再次強調：可見的 API 會被重複使用，而不是重新發明。確保開發人員可以輕鬆使用 API 至關重要。
為了實現這一點，我們需要為他們提供清晰的文件和有用的資源。這就是 SwaggerHub Portal 的作用，簡化了流程，讓開發人員更容易完成工作。
為什麼選擇 Portal？
SwaggerHub Portal API 使您能夠輕鬆地將您的 API 產品化。您可以建立一個具有品牌形象的登陸頁面，其中包含入門指南、資源和文件，幫助消費者了解您的 API 並將其整合到他們的應用程式中。
現在您可以使用我們自己的 SmartBear Portal 來自動化設定流程，並使您的入口網站栩栩如生。借助 SwaggerHub Portal API，您可以為開發人員提供一流的開發人員體驗 (DX)。他們將受益於使用者友好的介面和互動式文件，以加速 API 的採用。
開始使用
在深入探討細節之前，以下是一些開始使用所需的前提條件：
- SwaggerHub 帳戶：您需要 企業授權 的 Swagger Hub 帳戶。
- 使用者角色：您需要在您的 SwaggerHub 組織中具有設計師或擁有者角色才能調用 API。
- 啟用 SwaggerHub Portal：必須為您的組織啟用 Swagger Hub Portal。
在滿足這些先決條件後，您就可以使用 SwaggerHub Portal API 自動化設定開發人員入口網站的流程。
驗證
若要與 Portal API 互動，您需要來自 SwaggerHub 的 API 金鑰。此 API 金鑰應包含在每個 API 請求的「Authorization」標頭中，格式為「Bearer [your_api_key]」。
設定您的開發人員入口網站
首要步驟之一是自訂您的開發人員入口網站的外觀。雖然尚無法透過 API 上傳品牌圖片，但您可以設定強調色、字型和登陸頁面描述。
- 取得入口網站識別碼：若要管理您的入口網站設定，您需要使用對「portals」API 資源的呼叫來取得您的入口網站執行個體的識別碼。
- 設定入口網站設定：利用取得的入口網站 ID，透過 PATCH 請求更新您入口網站的設定。您可以調整強調色、字型和登陸頁面描述。
新增產品
產品是您開發人員入口網站的重要組成部分。您可以透過 Swagger Hub Portal API 管理產品內容，包括 API 定義和文件。
- 建立產品：將 POST 請求傳送到「products」端點以建立新產品。包含入口網站 ID、產品名稱、描述、slug 和其他相關詳細資訊。
- 新增標誌：輕鬆新增您的公司標誌，以增加整個入口網站的品牌形象。
填入產品內容
建立產品後，就該使用內容填入產品，包括 API 定義和文件。
- 建立區段：區段用作內容的預留位置。將 POST 請求傳送到「sections」端點，指定產品的區段。
- 新增 API：使用 POST 請求傳送到區段的「目錄」，以新增 API 參考。包含標題、slug 和內容（通常是 OpenAPI 定義的參考）。
- 新增文件：為了提供全面的文件，請在您的技術 API 參考旁邊新增 Markdown 文件。將 POST 請求傳送到區段，但這次使用 Markdown 內容。
- 發佈內容：最後，發佈產品內容，使其可在您的入口網站上存取。傳送請求以更新產品的已發佈內容。
下一步是什麼
Portal API 使您能夠簡化開發人員入口網站的設定和管理。無論您是新增產品、更新內容還是自訂入口網站的外觀，這些 API 都提供了一種強大的方式來自動化流程並增強開發人員體驗。
使用 Portal，您可以將空的開發人員入口網站轉換為使用者友好的 API 文件和資源中心。這種自助式方法可以增強您的開發團隊的能力，並加速 API 的採用。
立即將 Portal API 納入您的工作流程，以增強您的開發人員入口網站，並為開發人員提供他們成功所需的工具。如需詳細的逐步設定指南，請觀看SwaggerHub Portal API 入門。
免費試用！