設計和開發 API 涉及大量的重複和重寫描述。開發人員、組織或獨立團隊會在各種 API 設計中使用許多這類可重複使用的元件,而不斷地重寫它們可能會很繁瑣且令人沮喪。這正是 SwaggerHub 網域可以提供幫助的地方。簡而言之,網域是可重複使用元件的集合。可以儲存在網域內的元件有
- 定義:這些是描述您的 API 輸入和輸出的模型
- 路徑項目:一組可在路徑之間重複使用的預定義操作
- 參數:任何 API 的輸入
- 回應:發出 API 呼叫的輸出
SwaggerHub 上的網域管理方式與 API 相同。使用者可以建立網域並設定版本,然後在其中定義元件。元件可以由使用者或 API 上的協作者從其他 API 或網域參考。網域也可以作為多個 API 的控制中心,網域中的一個變更可以快速傳輸到所有參考該網域的 API,從而加快 API 開發和協作。
建立和使用網域
每個網域都有擁有者、名稱和版本。可以按一下右上角的「新增網域」來建立新的網域。
在設定網域的適當名稱和版本後,使用者可以在網域內新增所需的元件。放入元件後,即可發布網域。這是範例網域,可協助您開始使用。已發布的網域可以由其他網域和 API 可靠地參考。參考您自己的網域很容易!只需開始參考,讓 SwaggerHub 透過其新的自動建議功能協助您選擇正確的網域和元件。開始輸入您要參考的網域物件名稱,以顯示自動建議。這是根據您輸入的內容,自動建議如何帶出最有可能的物件。
您也可以使用以下語法直接參考公開或共用的私人網域: $ref: 'https://api.swaggerhub.com/domains/{ownerId}/{domainName}/{domainVersion}#/{componentType}/{componentName}'
管理網域
已建立的網域可以編輯、變更為不同的版本、推送到 Github 或刪除。網域可以是公開或私人的。公開網域可以由其他 Swaggerhub 使用者搜尋、檢視、參考和建立分支,而私人網域只能由您和您新增的協作者檢視和處理。使用者可以在搜尋列中選取「搜尋網域」,以搜尋其他使用者在 Swaggerhub 上發布的一些精選的公開網域。
網域使 API 設計人員的生活變得輕鬆。在 SwaggerHub 試用它們,如果您有任何其他問題,請隨時瀏覽我們的功能文件或常見問題集。