{"id":20290630,"url":"https://github.com/gocardless/simple-swag","last_synced_at":"2026-01-07T05:41:35.776Z","repository":{"id":44550981,"uuid":"376028188","full_name":"gocardless/simple-swag","owner":"gocardless","description":"Dead simple swagger/openapi docs server","archived":false,"fork":false,"pushed_at":"2022-02-08T14:47:05.000Z","size":12,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-02-03T10:25:07.589Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/gocardless.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-11T13:06:06.000Z","updated_at":"2024-01-23T09:08:48.000Z","dependencies_parsed_at":"2022-09-02T19:41:18.759Z","dependency_job_id":null,"html_url":"https://github.com/gocardless/simple-swag","commit_stats":null,"previous_names":["stephenbinns/simple-swag"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fsimple-swag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fsimple-swag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fsimple-swag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocardless%2Fsimple-swag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gocardless","download_url":"https://codeload.github.com/gocardless/simple-swag/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246117832,"owners_count":20726082,"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":[],"created_at":"2024-11-14T15:08:33.102Z","updated_at":"2026-01-07T05:41:30.734Z","avatar_url":"https://github.com/gocardless.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# simple-swag\n\nDead simple Swagger / OpenApi docs server, under the covers we use\nhttps://github.com/Redocly/redoc to present the docs.\n\n## Compatibilty\n\nAt the present time this server will work for OpenApi/Swagger docs version 2 \nor later.\n\n## Install\n\nThe easiest way to install is using go install\n\n```\ngo install github.com/gocardless/simple-swag@latest\n```\n\n## Usage\n\n```\nsimple-swag\n  -filename string\n    \ta path to the swagger/openapi spec (default \"~/swagger.json\")\n  -host string\n    \thost ip to serve using (default \"127.0.0.1\")\n  -port int\n    \tport to serve http over (default 9000)\n```\n\n## Troubleshooting\n\nIf you get the following error when attempting to run `simple-swag` it is \nlikely that Go isn't initialised properly in your shell.\n\nAdd the below lines to your `~/.zshrc` file.\n\n```\nexport GOPATH=$HOME/go\nexport PATH=$GOPATH/bin:$PATH\n```\nRun `source ~/.zshrc`\n\nTry running simple-swag again\n\n## License \u0026 Contributing\n\n* SimpleSwag is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n* Bug reports and pull requests are welcome on GitHub at https://github.com/gocardless/simple-swag\n\nGoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/about/careers/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fsimple-swag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgocardless%2Fsimple-swag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocardless%2Fsimple-swag/lists"}