Skip to content
This repository has been archived by the owner on Oct 6, 2022. It is now read-only.
/ swaggomnia Public archive

Command line tool for exporting from Insomnia and importing to Swagger

License

Notifications You must be signed in to change notification settings

Fyb3roptik/swaggomnia

Repository files navigation



Swaggomnia Build

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 which is now dead.

Support

Swaggomnia chat

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

License

This project is licensed under the MIT License - see the LICENSE file for details

About

Command line tool for exporting from Insomnia and importing to Swagger

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published