{"id":18222546,"url":"https://github.com/nerzal/atreugo-swagger","last_synced_at":"2025-09-14T18:17:15.353Z","repository":{"id":54815540,"uuid":"242563572","full_name":"Nerzal/atreugo-swagger","owner":"Nerzal","description":"swagger handler for atreugo","archived":false,"fork":false,"pushed_at":"2023-08-25T16:35:43.000Z","size":14277,"stargazers_count":7,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-03T03:32:53.516Z","etag":null,"topics":["api-documentation","atreugo","documentation","swag","swagger","swaggo"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nerzal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-23T17:51:46.000Z","updated_at":"2023-11-18T04:40:46.000Z","dependencies_parsed_at":"2024-06-19T05:29:56.989Z","dependency_job_id":"3c1cbf2c-0c7f-45c6-a3d8-38d73c12d169","html_url":"https://github.com/Nerzal/atreugo-swagger","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/Nerzal/atreugo-swagger","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nerzal%2Fatreugo-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nerzal%2Fatreugo-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nerzal%2Fatreugo-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nerzal%2Fatreugo-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nerzal","download_url":"https://codeload.github.com/Nerzal/atreugo-swagger/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nerzal%2Fatreugo-swagger/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275144993,"owners_count":25413128,"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","status":"online","status_checked_at":"2025-09-14T02:00:10.474Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-documentation","atreugo","documentation","swag","swagger","swaggo"],"created_at":"2024-11-03T23:04:49.558Z","updated_at":"2025-09-14T18:17:15.195Z","avatar_url":"https://github.com/Nerzal.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# atreugo-swagger\n[![codebeat badge](https://codebeat.co/badges/103ada91-026a-4027-b450-1a0ccbf8ce9a)](https://codebeat.co/projects/github-com-nerzal-atreugo-swagger-master)\n[![Go Report Card](https://goreportcard.com/badge/github.com/Nerzal/atreugo-swagger)](https://goreportcard.com/report/github.com/Nerzal/atreugo-swagger)\n[![Go Doc](https://godoc.org/github.com/Nerzal/atreugo-swagger?status.svg)](https://godoc.org/github.com/Nerzal/atreugo-swagger)\n[![Build Status](https://github.com/Nerzal/atreugo-swagger/workflows/Tests/badge.svg)](https://github.com/Nerzal/atreugo-swagger/actions?query=branch%3Amaster+event%3Apush)\n[![GitHub release](https://img.shields.io/github/tag/Nerzal/atreugo-swagger.svg)](https://GitHub.com/Nerzal/atreugo-swagger/releases/)\n[![codecov](https://codecov.io/gh/Nerzal/atreugo-swagger/branch/master/graph/badge.svg)](https://codecov.io/gh/Nerzal/atreugo-swagger)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FNerzal%2Fatreugo-swagger.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FNerzal%2Fatreugo-swagger?ref=badge_shield)\n\natreugo handler that serves swagger files. \n\nWorks with [swaggo](https://github.com/swaggo/swag)\n\nswagger files are from: [swaggofiles](https://github.com/swaggo/files)\n\n## atreugo v11 support\nUse atreugo-swagger v2.0.1 and above for atreugo v11 support\n\n## Paths\nServes swagger documentation under index.html\n\nServes redoc documentation under redoc.html\n\n## Example\n\n\n```go\npackage main\n\nimport (\n\tatreugoswagger \"github.com/Nerzal/atreugo-swagger/v3\"\n\t_ \"github.com/Nerzal/atreugo-swagger/example/docs\" // docs is generated by Swag CLI, you have to import it.\n\t\"github.com/savsgio/atreugo/v11\"\n)\n\n// @title Swagger Example API\n// @version 1.0\n// @description This is a sample server Petstore server.\n// @termsOfService http://swagger.io/terms/\n\n// @contact.name API Support\n// @contact.url http://www.swagger.io/support\n// @contact.email support@swagger.io\n\n// @license.name Apache 2.0\n// @license.url http://www.apache.org/licenses/LICENSE-2.0.html\n\n// @host petstore.swagger.io\n// @BasePath /v2\nfunc main() {\n\tconfig := \u0026atreugo.Config{\n\t\tAddr: \"0.0.0.0:1337\",\n\t}\n\n\ta := atreugo.New(config)\n\n\t// This will server all swagger files under the /docs/* path.\n\ta.GET(\"/docs/*doc\", atreugoswagger.AtreugoWrapHandler(atreugoswagger.Title(\"Test Title\")))\n\n\t// Start the server\n\terr := a.ListenAndServe()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n}\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnerzal%2Fatreugo-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnerzal%2Fatreugo-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnerzal%2Fatreugo-swagger/lists"}