在 20 分鐘內於 GitHub 上建立 API 儲存庫

  2016 年 11 月 25 日

好的,您正在瀏覽 swagger.io 網站,所以您可能正計畫為您的 API 編寫 OpenAPI 規格,或者您已經有了。那麼將它發佈到 GitHub 上如何呢?

在 GitHub 上發佈規格

具有 OpenAPI 規格的 GitHub 儲存庫有幾個好處

  • 在 GitHub Pages 上託管(完美的正常運行時間、CDN、Jekyll、具有 CNAME 的自訂網域)
  • 在 GitHub 社群中宣傳
  • 修訂歷史、分支、CI
  • 快速上手時間(每個人都知道如何使用 GitHub?)

但主要優勢是社群參與:您的 API 使用者可以透過開啟 PR 和 issue 來提供回饋!請參閱以下螢幕截圖中 Spotify 的運作方式

許多大型公司已經跟隨這個趨勢

建立 GitHub 儲存庫並將您的規格放入其中非常容易,但有時您需要實作驗證、文件產生、部署等功能。

我們已經為您準備好了!

我們 APIs.guru 的團隊受聘為 Rebilly Inc. 建立此類儲存庫。Rebilly 喜歡我們的解決方案,並要求為他們的內部/實驗性 API 建立此類儲存庫。他們非常友善地贊助了 generator-openapi-repo 的開發 - 這是一個用於 GitHub 託管 API 入口網站的開源自動產生器。

設定此類儲存庫所需的一切,就是執行我們的工具並回答幾個非常簡單的問題

立即試用!

這非常簡單,我們鼓勵您立即試用

在 20 分鐘內,您將在 GitHub 上託管一個 API 儲存庫,其中包含以下精巧的功能

  • 在 Travis 上持續整合/部署
  • 支援將程式碼範例作為獨立檔案
  • 每次提交後驗證 OpenAPI 規格
  • ReDoc + SwaggerUI 託管在 Github Pages 上(您可以使用自訂網域)
  • 在您最喜歡的編輯器或 swagger-editor 中進行即時編輯?

歡迎在 GitHub 儲存庫上開啟 issue 和功能請求。