在 20 分钟内即可在 GitHub 上建立 API 仓库

  2016 年 11 月 25 日

好的,您正在 swagger.io 网站上,因此您可能正计划为您的 API 编写 OpenAPI 规范,或者您已经有了规范。 那么将其发布到 GitHub 上如何呢?

在 GitHub 上发布规范

带有 OpenAPI 规范的 GitHub 仓库有以下几个好处

  • 托管在 GitHub Pages 上(完美的正常运行时间、CDN、Jekyll、带有 CNAME 的自定义域)
  • 在 GitHub 社区中推广
  • 修订历史、分支、CI
  • 快速上手时间(每个人都知道如何使用 GitHub?)

但主要优点是社区参与:您的 API 用户可以通过打开 PR 和问题来提供反馈! 请看下面的截图,了解 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 仓库上提出问题和功能请求。