https://github.com/mlabouardy/swaggymnia

Generate Swagger 🌀 documentation for your existing API in Insomnia
https://github.com/mlabouardy/swaggymnia

api docs insomnia rest-api swagger

Last synced: 6 days ago
JSON representation

Generate Swagger 🌀 documentation for your existing API in Insomnia

• Host: GitHub
• URL: https://github.com/mlabouardy/swaggymnia
• Owner: mlabouardy
• License: mit
• Created: 2017-10-10T14:20:19.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-10-26T02:54:59.000Z (about 3 years ago)
• Last Synced: 2024-12-08T10:35:54.266Z (14 days ago)
• Topics: api, docs, insomnia, rest-api, swagger
• Language: Go
• Homepage:
• Size: 200 KB
• Stars: 428
• Watchers: 11
• Forks: 31
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



[![CircleCI](https://circleci.com/gh/mlabouardy/swaggymnia/tree/master.svg?style=svg&circle-token=bcfce92d1e46aaf0d50b4b3fa8baf8406d4bc115)](https://circleci.com/gh/mlabouardy/swaggymnia/tree/master) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/mlabouardy/swaggymnia)](https://goreportcard.com/report/github.com/mlabouardy/swaggymnia)

Generate Swagger Documentation from Insomnia REST Client

## Download

Below are the available downloads for the latest version of Swaggymnia  (1.0.0-beta). Please download the proper package for your operating system and architecture.

### Linux:

```

wget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/linux/swaggymnia

```

### Windows:

```

wget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/windows/swaggymnia

```

### Mac OS X:

```

wget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/osx/swaggymnia

```

### FreeBSD:

```

wget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/freebsd/swaggymnia

```

### OpenBSD:

```

wget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/openbsd/swaggymnia

```

## How to use it

See usage with:

```

$ swaggymnia --help

```

Generate Swagger documentation:

```

$ swaggymnia generate -insomnia INSOMNIA_EXPORTED_FILE -config CONFIG_FILE -output FORMAT

```

| Option | Description |

| ------ | ----------- |

| -insomnia | Insomnia exported file |

| -config | API Global Configuration file (see [Configuration Format](#configuration-format))|

| -output | Insomnia output format (json or yaml, default json)  |

## Example

Let's convert the following Insomnia API documentation to Swagger:



  



Issue the following command:

```

$ swaggymnia generate -i examples/watchnow.json -c examples/config.json -o json

```



  



## Configuration Format

```

{

  "title" : "API Name",

  "version" : "API version",

  "host" : "API URL",

  "basePath" : "Base URL",

  "schemes" : "HTTP protocol",

  "description" : "API description"

}

```

## Tutorials

* [Generate beautiful Swagger Documentation from Insomnia](http://www.blog.labouardy.com/generate-swagger-documentation-from-insomnia-rest-client/)

## Maintainers

- Mohamed Labouardy - [email protected]

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details