Swagger 2.0
[![Tests][test-badge]][test-url] [![Coverage][cov-badge]][cov-url] [![CI vuln scan][vuln-scan-badge]][vuln-scan-url] [![CodeQL][codeql-badge]][codeql-url] [![Release][release-badge]][release-url] [![Container Registry on Quay.io][quay-badge]][quay-url] [![Container Registry on Github][ghcr-badge]][ghcr-url] [![CodeFactor Grade][codefactor-badge]][codefactor-url] [![License][license-badge]][license-url] [![Open SSF Scorecard][ossf-badge]][ossf-url] [![OpenSSF Best Practices][ossf-cci-badge]][ossf-cci-url] [![OpenSSF Baseline][ossf-baseline]][ossf-cci-url] [![OSS licences status][fossa-badge]][fossa-url] [![Documentation][doc-badge]][doc-url] [![GoDoc][godoc-badge]][godoc-url] [![Discord Channel][discord-badge]][discord-url] [![go version][goversion-badge]][goversion-url] ![Top language][top-badge] ![Commits since latest release][commits-badge]
This project contains a golang implementation of Swagger 2.0 (aka OpenAPI 2.0). It provide tools to work with swagger specifications.
Swagger is a simple yet powerful representation of your RESTful API.
Announcements
You may join the discord community by clicking the invite link on the discord badge. [![Discord Channel][discord-badge]][discord-url].
- 2026-08-15 : Docker image users - shipping v0.36.4 to address critical vulnerability in golang
- 2026-08-11 : v0.36.3 lands soon (ETA 08/14)
- 2026-07-31 : v0.36.0 is released
Documentation
Features
go-swagger brings to the go community a complete suite of fully-featured, high-performance, API components to work with a Swagger API: server, client and data model.
- Generates a server from a swagger specification
- Generates a client from a swagger specification
- Generates a CLI (command line tool) from a swagger specification (alpha stage)
- Supports most features offered by jsonschema and swagger, including polymorphism
- Generates a swagger specification from annotated go code
- Additional tools to work with a swagger spec
- Great customization features, with vendor extensions and customizable templates
Project status
This project supports OpenAPI 2.0. At this moment it does not support OpenAPI 3.x.
go-swagger is now feature complete and has stabilized its API.
Most features and building blocks are now in a stable state, with a rich set of CI tests.
The go-openapi community actively continues bringing fixes and enhancements to this code base.
There is still much room for improvement: contributors and PR's are welcome. You may also get in touch with maintainers on our [![Discord Channel][discord-badge]][discord-url].
Installing
go install github.com/go-swagger/go-swagger/cmd/swagger@latestgo-swagger is also available as binary or docker releases as well as from source: more details.
Try it
Try go-swagger in a free online workspace using Gitpod:
Security
go-swagger turns an OpenAPI 2.0 specification into source code. Treat a specification like any other untrusted input: if you obtained it from a remote or untrusted location, review its contents before generating code from it.
The generator never executes the spec, and the generated code runs only when you build and import it. We have hardened the generators against an adversarial spec that tries to inject unwanted Go into the artifacts it produces — identifiers, struct tags, doc comments and CLI string literals are sanitized or escaped — which substantially reduces the exposure. It is not, however, a substitute for reviewing what you generate. In particular:
- Remote
$refs. A spec may reference other documents, possibly over the network. Those references are resolved and folded into the generated code, so inspect any external reference you do not control. - The
x-go-typeextension. By design, this extension lets the spec choose the Go type for a field — including an arbitrary imported package. That capability cannot easily be safeguarded: a spec usingx-go-typecan make your generated code import and depend on a package of its choosing. Always review specs that rely on it.
Licensing
The toolkit itself is licensed under an Apache Software License 2.0: SPDX-License-Identifier: Apache-2.0.
Just like swagger, this does not cover code generated by the toolkit. That code is entirely yours to license however you see fit.
Licence scan on dependencies
[![FOSSA Status][fossa-badge-large]][fossa-url-large]
[test-badge]: https://github.com/go-swagger/go-swagger/actions/workflows/go-test.yml/badge.svg [test-url]: https://github.com/go-swagger/go-swagger/actions/workflows/go-test.yml [cov-badge]: https://codecov.io/gh/go-swagger/go-swagger/branch/master/graph/badge.svg [cov-url]: https://codecov.io/gh/go-swagger/go-swagger [vuln-scan-badge]: https://github.com/go-swagger/go-swagger/actions/workflows/scanner.yml/badge.svg [vuln-scan-url]: https://github.com/go-swagger/go-swagger/actions/workflows/scanner.yml [codeql-badge]: https://github.com/go-swagger/go-swagger/actions/workflows/codeql.yml/badge.svg [codeql-url]: https://github.com/go-swagger/go-swagger/actions/workflows/codeql.yml [release-badge]: https://badge.fury.io/gh/go-swagger%2Fgo-swagger.svg [release-url]: https://badge.fury.io/gh/go-swagger%2Fgo-swagger [quay-badge]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fquay.io%2Fapi%2Fv1%2Frepository%2Fgoswagger%2Fswagger%2Ftag%2F%3Flimit%3D1%26onlyActiveTags%3Dtrue%26filter_tag_name%3Dlike%3Av&label=Container%20Registry%20on%20quay.io&query=%24.tags[:1].name&logo=redhatopenshift&logoColor=#EE0000?color=green [quay-url]: https://quay.io/repository/goswagger/swagger?tab=tags [ghcr-badge]: https://ghcr-badge-ipv2.onrender.com/go-swagger/go-swagger/latest_tag?ignore=sha-*,edge,master&label=Container%20Registry%20on%20Github [ghcr-url]: https://github.com/orgs/go-swagger/packages/container/go-swagger/versions?filters[version_type]=tagged [codefactor-badge]: https://img.shields.io/codefactor/grade/github/go-swagger/go-swagger [codefactor-url]: https://www.codefactor.io/repository/github/go-swagger/go-swagger [doc-badge]: https://img.shields.io/badge/doc-site-blue?link=https%3A%2F%2Fgoswagger.io%2Fgo-swagger%2F [doc-url]: https://goswagger.io/go-swagger [godoc-badge]: https://godoc.org/github.com/go-swagger/go-swagger?status.svg [godoc-url]: http://godoc.org/github.com/go-swagger/go-swagger [discord-badge]: https://img.shields.io/discord/1446918742398341256?logo=discord&label=discord&color=blue [discord-url]: https://discord.gg/FfnFYaC3k5 [codescan-doc-url]: https://go-openapi.github.io/codescan/ [license-badge]: http://img.shields.io/badge/license-Apache%20v2-orange.svg [license-url]: https://github.com/go-swagger/go-swagger/?tab=Apache-2.0-1-ov-file#readme [ossf-badge]: https://api.securityscorecards.dev/projects/github.com/go-swagger/go-swagger/badge [ossf-url]: https://securityscorecards.dev/viewer/?uri=github.com/go-swagger/go-swagger [ossf-cci-badge]: https://www.bestpractices.dev/projects/11359/badge [ossf-cci-url]: https://www.bestpractices.dev/projects/11359 [ossf-baseline]: https://www.bestpractices.dev/projects/11359/baseline [fossa-badge]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger.svg?type=shield [fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger?ref=badge_shield [fossa-badge-large]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger.svg?type=large [fossa-url-large]: https://app.fossa.io/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger?ref=badge_large [oai-url]: https://raw.githubusercontent.com/swagger-api/swagger-spec/master/LICENSE [goversion-badge]: https://img.shields.io/github/go-mod/go-version/go-swagger/go-swagger [goversion-url]: https://github.com/go-swagger/go-swagger/blob/master/go.mod [top-badge]: https://img.shields.io/github/languages/top/go-swagger/go-swagger [commits-badge]: https://img.shields.io/github/commits-since/go-swagger/go-swagger/latest