如何共享 Swagger 文档 [英] How to share Swagger documentation

问题描述

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

I recently started using Swagger for my documentation but there are few things that are still unclear to me. I created my YAML document and now I would like to be able to share my documentation in a .pdf or HTML/Javascript page with the rest of my team. I can't use SwaggerHub because they don't have private repositories and Swagger Editor doesn't appear to allow to share the panel on the right.

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

Just to be clear, I would like to be able to get something like:

我错过了什么?

推荐答案

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

DynamicApis.com is a new API portal that is up-and-coming and they have an awesome integration guide you can build for free using your Swagger JSON. Check out https://www.dynamicapis.com/app/quickguide. Here is an example of one that a friend of mine generated. http://bit.ly/1RIVvGN.

它们还允许您像 GitHub 一样创建 API 门户，并让您上传 Swagger 2.0 文档，以便为您的 API 生成出色的 UI.您也可以访问他们的网站并查看一些示例门户以查看用户界面.

They also allow you to create your API portal like GitHub and let you upload your Swagger 2.0 documents to generate an awesome UI for your APIs. You can go to their site and check out some example portals to see the UI too.

它们会为您的集成指南生成 bit.ly 链接，以便您可以与他人分享.

They generate bit.ly links for your integration guides so you can share with people.

希望这会有所帮助！

这篇关于如何共享 Swagger 文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！