All geek questions in one place

How to share Swagger documentation

I recently started using Swagger for my documentation, but there are a few things that are still not clear. I created my YAML document, and now I would like to be able to share my documentation on a .pdf or HTML / Javascript page with the rest of my team. I cannot use SwaggerHub because they do not have private repositories, and the Swagger editor does not allow access to the panel on the right.

To be clear, I would like to get something like:

enter image description here

What am I missing?

+5
source share
2 answers

I am prone to working on swaggerhub, but what the project is for:

https://swaggerhub.com

From there, you can automatically enter your swagger specifications in github, as well as make other users' collaborators in the API (or just for reading).

+1
source

DynamicApis.com is the new API portal that is moving forward, and they have an awesome integration guide that you can create for free using your Swagger JSON. Check out https://www.dynamicapis.com/app/quickguide . Here is an example of what my friend created. http://bit.ly/1RIVvGN .

They also allow you to create your own API portal, such as GitHub, and allow you to download your Swagger 2.0 documents to create a stunning user interface for your APIs. You can go to their site and see some sample portals to see the interface.

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

Hope this helps!

-1
source

Source: https://habr.com/ru/post/1234563/

More articles:


All Articles