如何共享Swagger文档

时间:2015-10-26 23:06:06

标签: javascript api rest documentation swagger

我最近开始使用Swagger作为我的文档,但有些事情我仍然不清楚。我创建了我的YAML文档,现在我希望能够在我的团队其他成员的.pdf或HTML / Javascript页面中共享我的文档。我不能使用SwaggerHub,因为它们没有私有存储库,并且Swagger Editor似乎不允许在右侧共享面板。

为了清楚起见,我希望能得到类似的东西:

enter image description here

我错过了什么?

2 个答案:

答案 0 :(得分:1)

当我在swaggerhub上工作时,我很有偏见,但这就是该项目的用途:

https://swaggerhub.com

从那里,你可以自动将你的swagger规范推送到github,也可以让API上的其他用户协作者(或只是只读)。

答案 1 :(得分:-1)

DynamicApis.com是一个崭露头角的新API门户,它们有一个很棒的集成指南,您可以使用Swagger JSON免费构建。查看https://www.dynamicapis.com/app/quickguide。 这是我的一个朋友生成的一个例子。 http://bit.ly/1RIVvGN

它们还允许您像GitHub一样创建API门户,并允许您上传Swagger 2.0文档,为您的API生成一个非常棒的UI。 您可以访问他们的网站并查看一些示例门户网站以查看用户界面。

他们为您的集成指南生成bit.ly链接,以便您与人分享。

希望这有帮助!