在不到20分钟内将API仓库部署到GitHub

  2016年11月25日

好的,你正在访问swagger.io网站,所以你可能正计划为你的API编写OpenAPI规范,或者你已经有了。那么,把它发布到GitHub上怎么样?

在GitHub上发布规范

包含OpenAPI规范的GitHub仓库有以下几个优势

  • 在GitHub Pages上托管(完美运行时间、CDN、Jekyll、带CNAME的自定义域名)
  • 在GitHub社区中推广
  • 版本历史、分支、持续集成
  • 快速上手(谁不会用GitHub呢?)

但主要优势在于社区参与:您的API用户可以通过提交PR和问题来提供反馈!请看下方截图中Spotify的示例。

许多大公司已经跟随这一趋势

创建GitHub仓库并将您的规范放在那里非常简单,但在某个时候您将不得不实现诸如验证、文档生成、部署等功能。

我们为您提供支持!

我们APIs.guru受托为Rebilly Inc.设置了这样的仓库。Rebilly很喜欢我们的解决方案,并要求为他们的内部/实验性API也设置类似的仓库。他们非常慷慨地赞助了generator-openapi-repo的开发——这是一个GitHub托管API门户的开源自动生成器。

设置这样的仓库,您只需运行我们的工具并回答几个非常简单的问题。

立即尝试!

它非常简单,我们鼓励您立即尝试

在不到20分钟内,您将在GitHub上拥有一个API仓库,并具备以下实用功能:

  • 在Travis上进行持续集成/部署
  • 支持代码示例作为独立文件
  • 每次提交后进行OpenAPI规范验证
  • 在GitHub Pages上托管ReDoc + SwaggerUI(您可以使用自定义域名)
  • 在您喜欢的编辑器或swagger-editor中进行实时编辑?

欢迎在GitHub仓库中提交问题和功能请求。

© . All rights reserved.