{"id":13472203,"url":"https://github.com/mlabouardy/swaggymnia","last_synced_at":"2025-04-06T12:09:52.075Z","repository":{"id":49168713,"uuid":"106427300","full_name":"mlabouardy/swaggymnia","owner":"mlabouardy","description":"Generate Swagger 🌀 documentation for your existing API in Insomnia","archived":false,"fork":false,"pushed_at":"2021-10-26T02:54:59.000Z","size":205,"stargazers_count":426,"open_issues_count":15,"forks_count":29,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-30T11:07:17.773Z","etag":null,"topics":["api","docs","insomnia","rest-api","swagger"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mlabouardy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-10T14:20:19.000Z","updated_at":"2025-03-26T18:08:00.000Z","dependencies_parsed_at":"2022-08-26T01:11:56.060Z","dependency_job_id":null,"html_url":"https://github.com/mlabouardy/swaggymnia","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlabouardy%2Fswaggymnia","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlabouardy%2Fswaggymnia/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlabouardy%2Fswaggymnia/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlabouardy%2Fswaggymnia/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mlabouardy","download_url":"https://codeload.github.com/mlabouardy/swaggymnia/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247478323,"owners_count":20945266,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","docs","insomnia","rest-api","swagger"],"created_at":"2024-07-31T16:00:52.880Z","updated_at":"2025-04-06T12:09:52.051Z","avatar_url":"https://github.com/mlabouardy.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"logo.png\" width=\"50%\"/\u003e\n\u003c/div\u003e\n\n[![CircleCI](https://circleci.com/gh/mlabouardy/swaggymnia/tree/master.svg?style=svg\u0026circle-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)\n\nGenerate Swagger Documentation from Insomnia REST Client\n\n## Download\n\nBelow 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.\n\n### Linux:\n\n```\nwget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/linux/swaggymnia\n```\n\n### Windows:\n\n```\nwget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/windows/swaggymnia\n```\n\n### Mac OS X:\n\n```\nwget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/osx/swaggymnia\n```\n\n### FreeBSD:\n\n```\nwget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/freebsd/swaggymnia\n```\n\n### OpenBSD:\n\n```\nwget https://s3.amazonaws.com/swaggymnia/1.0.0-beta/openbsd/swaggymnia\n```\n\n## How to use it\n\nSee usage with:\n\n```\n$ swaggymnia --help\n```\n\nGenerate Swagger documentation:\n\n```\n$ swaggymnia generate -insomnia INSOMNIA_EXPORTED_FILE -config CONFIG_FILE -output FORMAT\n```\n\n| Option | Description |\n| ------ | ----------- |\n| -insomnia | Insomnia exported file |\n| -config | API Global Configuration file (see [Configuration Format](#configuration-format))|\n| -output | Insomnia output format (json or yaml, default json)  |\n\n\n## Example\n\nLet's convert the following Insomnia API documentation to Swagger:\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"insomnia.png\"/\u003e\n\u003c/div\u003e\n\nIssue the following command:\n\n```\n$ swaggymnia generate -i examples/watchnow.json -c examples/config.json -o json\n```\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"swagger.png\"/\u003e\n\u003c/div\u003e\n\n## Configuration Format\n\n```\n{\n  \"title\" : \"API Name\",\n  \"version\" : \"API version\",\n  \"host\" : \"API URL\",\n  \"basePath\" : \"Base URL\",\n  \"schemes\" : \"HTTP protocol\",\n  \"description\" : \"API description\"\n}\n```\n\n## Tutorials\n\n* [Generate beautiful Swagger Documentation from Insomnia](http://www.blog.labouardy.com/generate-swagger-documentation-from-insomnia-rest-client/)\n\n## Maintainers\n\n- Mohamed Labouardy - mohamed@labouardy.com\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlabouardy%2Fswaggymnia","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmlabouardy%2Fswaggymnia","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlabouardy%2Fswaggymnia/lists"}