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