https://github.com/Fyb3roptik/swaggomnia
Command line tool for exporting from Insomnia and importing to Swagger
https://github.com/Fyb3roptik/swaggomnia
hacktoberfest
Last synced: over 1 year ago
JSON representation
Command line tool for exporting from Insomnia and importing to Swagger
- Host: GitHub
- URL: https://github.com/Fyb3roptik/swaggomnia
- Owner: Fyb3roptik
- License: mit
- Archived: true
- Created: 2019-06-04T14:16:23.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-11-24T09:03:32.000Z (over 4 years ago)
- Last Synced: 2024-11-07T00:42:10.317Z (over 1 year ago)
- Topics: hacktoberfest
- Language: Go
- Homepage:
- Size: 2.59 MB
- Stars: 95
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Description
THIS IS A DEAD REPO NOW. Insomnia should now support this internally.
Generate Swagger Documentation from Insomnia REST Client.
*This is a fork of [swaggymnia](https://github.com/mlabouardy/swaggymnia) which is now dead.*
## Support
[](https://gitter.im/swaggomnia/community)
## Changelog
`2.0.1`
* Updated Logo
`2.0`
* Open API 3 support
* Insomnia v4 support
* New Config Format
## How to use it
See usage with:
```
$ swaggomnia --help
```
Generate Swagger documentation:
```
$ swaggomnia 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:
```
$ swaggomnia generate -i examples/watchnow.json -c examples/config.json -o json
```
## Configuration Format
```
{
"title" : "API Name",
"version" : "API version",
"basePath" : "https://api.domain.com/v1",
"description" : "API description"
}
```
## Maintainers
- Nick Wallace - nwallace@fyberstudios.com - New Author
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details