How to share Swagger documentation

寵の児 提交于 2019-12-22 07:12:55

问题


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:

What am I missing?


回答1:


I'm biased as I work on swaggerhub, but that's what the project is for:

https://swaggerhub.com

From there, you can push your swagger specs automatically to github and also make other users collaborators on the API (or just read-only).




回答2:


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.

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.

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

Hope this helps!



来源:https://stackoverflow.com/questions/33357160/how-to-share-swagger-documentation

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!