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

问题描述

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

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屋！