# swag

Command-line tool that generates Swagger 2.0 API documentation for Go projects from annotations in the source code.


Source: https://findsoftware.frbit.cloud/swag/
Last reviewed: 2026-11-16
Listed since: 2026-11-16

## Record

### Links

- repository: https://github.com/swaggo/swag
- docs: https://github.com/swaggo/swag#getting-started
- plugins: https://github.com/swaggo/swag#supported-web-frameworks

### Identity

- status: active
- maintainer: Eason Lin
- maintainerType: individual
- parent: unknown
- firstRelease: 2017
- hqCountry: unknown

### Kind

- category: dev-tool, backend
- hosting: binary
- language: go
- runtime: binary
- runtimeMin: unknown
- basedOn: unknown

### Content

- contentStore: unknown
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: unknown

### Rendering and deploy

- runsAs: unknown
- renderingModes: unknown
- installMethod: go install, docker, download

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 1
- latestReleaseDate: 2025-07-29

### Adoption

- githubStargazers: 13053
- packagistDownloads: not applicable
- npmWeeklyDownloads: not applicable
- contributors: 251
- pluginCount: 10
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 5009
- dependentPackages: 3609

### Sources

- name: https://raw.githubusercontent.com/swaggo/swag/v1.16.6/README.md (read 2026-11-16)
- urls: https://api.github.com/repos/swaggo/swag (read 2026-11-16)
- urls: https://raw.githubusercontent.com/swaggo/swag/v1.16.6/README.md (read 2026-11-16)
- firstRelease: https://api.github.com/repos/swaggo/swag/releases (read 2026-11-16)
- maintainer: https://raw.githubusercontent.com/swaggo/swag/master/license (read 2026-11-16)
- maintainerType: https://raw.githubusercontent.com/swaggo/swag/master/license (read 2026-11-16)
- language: https://api.github.com/repos/swaggo/swag (read 2026-11-16)
- category: https://raw.githubusercontent.com/swaggo/swag/v1.16.6/README.md (read 2026-11-16)
- runtime: https://raw.githubusercontent.com/swaggo/swag/v1.16.6/README.md (read 2026-11-16)
- installMethod: https://raw.githubusercontent.com/swaggo/swag/v1.16.6/README.md (read 2026-11-16)
- installMethod: https://raw.githubusercontent.com/swaggo/swag/v1.16.6/README.md (read 2026-11-16)
- installMethod: https://raw.githubusercontent.com/swaggo/swag/v1.16.6/README.md (read 2026-11-16)
- license: https://raw.githubusercontent.com/swaggo/swag/master/license (read 2026-11-16)
- licenseModel: https://raw.githubusercontent.com/swaggo/swag/master/license (read 2026-11-16)
- currentMajor: https://api.github.com/repos/swaggo/swag/releases (read 2026-11-16)
- latestReleaseDate: https://api.github.com/repos/swaggo/swag/releases (read 2026-11-16)
- githubStargazers: https://api.github.com/repos/swaggo/swag (read 2026-11-16)
- contributors: https://api.github.com/repos/swaggo/swag/contributors?per_page=1 (read 2026-11-16)
- urls: https://raw.githubusercontent.com/swaggo/swag/v1.16.6/README.md (read 2026-11-16)
- pluginCount: https://raw.githubusercontent.com/swaggo/swag/v1.16.6/README.md (read 2026-11-16)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/proxy.golang.org/packages/github.com%2Fswaggo%2Fswag (read 2026-11-16)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/proxy.golang.org/packages/github.com%2Fswaggo%2Fswag (read 2026-11-16)

## Notes

swag is a Go command-line tool that generates Swagger 2.0 documentation from annotations written as comments in Go source code. The [getting started section](https://github.com/swaggo/swag#getting-started) starts by adding those comments to the API source code.

Integrations for several Go web frameworks are separate repositories, listed in the README under its supported frameworks.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0
