I recently built a tool called to generate documentation for an existing API in REST client. So brace yourself for a short but interesting quick tip read. Swaggymnia Swagger Insomnia Start by downloading , find the appropriate for your system and download it. For linux: Swaggymnia package wget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/linux/swaggymnia After downloading . Add the execution permission to the binary: Swaggymnia chmod +x swaggymnia Note: For make sure that binary is available on the . contains instructions for setting the on . Windows swaggymnia PATH This page PATH Windows After installing, verify the installation worked, by opening a new terminal session and checking if is available : swaggymnia Once done, export your API from : Insomnia Next, create a configuration file with the format below: Then, issue the following command: swaggymnia generate -i watchnow.json -c config.json -o yaml As result, you should see a new file called generated: swagger.yml Now our Swagger spec is generated, you can publish your Swagger spec as customer-facing documentation. For this purpose you can use , which converts your Swagger spec into a beautiful, interactive API documentation. Swagger UI You can download from . It is just a bundle of HTML, CSS and JS files, which doesn’t require a framework or anything, so they can be installed in a directory on any HTTP server. Swagger UI here Once you have downloaded it, you put your file into the directory — and open and change it to point at your swagger file instead of swagger.yaml dist index.html . http://petstore.swagger.io/v2/swagger.json Then you can open in your browser, and see your new beautiful, interactive API documentation: index.html

Generate beautiful Swagger API documentation from Insomnia

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Add new users to EC2 and give SSH Key access

100 Days of AI Day 1: From Newsletter to Podcast, Leveraging AI for Audio Transformation

10 Threats to an Open API Ecosystem

10 Indications That You Should Invest in Automation Via APIs

10 Best Practices for Securing Your API

The Noonification: Getting Your API Into Production (10/28/2022)

Add new users to EC2 and give SSH Key access

100 Days of AI Day 1: From Newsletter to Podcast, Leveraging AI for Audio Transformation

10 Threats to an Open API Ecosystem

10 Indications That You Should Invest in Automation Via APIs

10 Best Practices for Securing Your API

The Noonification: Getting Your API Into Production (10/28/2022)

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps