如何共享 Swagger 文档

Question

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?

Answer 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).

Answer 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!

Answer 3

We are trying to collaborate with another company but only have the basic four licence Team arrangement. It is a product we are developing so my API has to be private. I am using SwaggerHub but was disappointed to see that users can only see my private APIs if they are "collaborators" and hence covered by a paid licence (you can easily share public APIs on SwaggerHub). I guess this will mean hosting the HTML doco (which you can download from your SwaggerHub API) in my own Cloud-hosted instance of Swagger UI and securing it behind a logon...Open to suggestions!