Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/go-swagger/go-swagger

Swagger 2.0 implementation for go
https://github.com/go-swagger/go-swagger

api code-generator go golang swagger-codegen swagger-spec swagger-specification

Last synced: 3 days ago
JSON representation

Swagger 2.0 implementation for go

Awesome Lists containing this project

README 

        
# Swagger 2.0 [![Run CI](https://github.com/go-swagger/go-swagger/actions/workflows/test.yaml/badge.svg)](https://github.com/go-swagger/go-swagger/actions/workflows/test.yaml) [![codecov](https://codecov.io/gh/go-swagger/go-swagger/branch/master/graph/badge.svg)](https://codecov.io/gh/go-swagger/go-swagger)[![Go Report Card](https://goreportcard.com/badge/github.com/go-swagger/go-swagger)](https://goreportcard.com/report/github.com/go-swagger/go-swagger)



[![GitHub version](https://badge.fury.io/gh/go-swagger%2Fgo-swagger.svg)](https://badge.fury.io/gh/go-swagger%2Fgo-swagger) [![Docker Repository on Quay](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=Docker%20Repository%20on%20Quay&query=%24.tags[:1].name)](https://quay.io/repository/goswagger/swagger?tab=tags) [![Docker Repository on Github](https://ghcr-badge.egpl.dev/go-swagger/go-swagger/latest_tag?trim=major&ignore=sha-*&label=Docker%20Repository%20on%20Github)](https://github.com/orgs/go-swagger/packages/container/go-swagger/versions) ![GitHub commits since latest release](https://img.shields.io/github/commits-since/go-swagger/go-swagger/latest)



[![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)

[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/swagger-api/swagger-spec/master/LICENSE)

[![GoDoc](https://godoc.org/github.com/go-swagger/go-swagger?status.svg)](http://godoc.org/github.com/go-swagger/go-swagger)



[![Open SSF Scorecard](https://api.securityscorecards.dev/projects/github.com/go-swagger/go-swagger/badge)](https://securityscorecards.dev/viewer/?uri=github.com/go-swagger/go-swagger)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger?ref=badge_shield)



---



This project contains a golang implementation of Swagger 2.0 (aka [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)).

It provide tools to work with swagger specifications.



[Swagger](https://swagger.io/) is a simple yet powerful representation of your RESTful API.



## 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



Our focus with code generation is to produce idiomatic, fast go code, which plays nice with golint, go vet etc.



[More details](https://goswagger.io/go-swagger/features).



##  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 slack channel](https://slackin.goswagger.io).



## Installing



```sh

go install github.com/go-swagger/go-swagger/cmd/swagger@latest

```



`go-swagger` is also available as binary or docker releases as well as from source: [more details](https://goswagger.io/go-swagger/install).



## Try it



Try `go-swagger` in a free online workspace using Gitpod:



[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/go-swagger/go-swagger)



## Licensing



The toolkit itself is licensed under an Apache Software License 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](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger?ref=badge_large)