github.com/go-swagger/go-swagger@v0.31.0/README.md (about)

     1  # 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)
     2  
     3  [![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)
     4  
     5  [![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)
     6  [![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/swagger-api/swagger-spec/master/LICENSE)
     7  [![GoDoc](https://godoc.org/github.com/go-swagger/go-swagger?status.svg)](http://godoc.org/github.com/go-swagger/go-swagger)
     8  
     9  [![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)
    10  [![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)
    11  
    12  ---
    13  
    14  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)).
    15  It provide tools to work with swagger specifications.
    16  
    17  [Swagger](https://swagger.io/) is a simple yet powerful representation of your RESTful API.<br>
    18  
    19  ## Documentation
    20  
    21  <https://goswagger.io>
    22  
    23  ##  Features
    24  
    25  `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.
    26  
    27  * Generates a server from a swagger specification
    28  * Generates a client from a swagger specification
    29  * Generates a CLI (command line tool) from a swagger specification (alpha stage)
    30  * Supports most features offered by jsonschema and swagger, including polymorphism
    31  * Generates a swagger specification from annotated go code
    32  * Additional tools to work with a swagger spec
    33  * Great customization features, with vendor extensions and customizable templates
    34  
    35  Our focus with code generation is to produce idiomatic, fast go code, which plays nice with golint, go vet etc.
    36  
    37  [More details](https://goswagger.io/go-swagger/features).
    38  
    39  ##  Project status
    40  
    41  This project supports OpenAPI 2.0. **At this moment it does not support OpenAPI 3.x**.
    42  
    43  `go-swagger` is now feature complete and has stabilized its API.
    44  
    45  Most features and building blocks are now in a stable state, with a rich set of CI tests.
    46  
    47  The go-openapi community actively continues bringing fixes and enhancements to this code base.
    48  
    49  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).
    50  
    51  ## Installing
    52  
    53  ```sh
    54  go install github.com/go-swagger/go-swagger/cmd/swagger@latest
    55  ```
    56  
    57  `go-swagger` is also available as binary or docker releases as well as from source: [more details](https://goswagger.io/go-swagger/install).
    58  
    59  ## Try it
    60  
    61  Try `go-swagger` in a free online workspace using Gitpod:
    62  
    63  [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/go-swagger/go-swagger)
    64  
    65  ## Licensing
    66  
    67  The toolkit itself is licensed under an Apache Software License 2.0.
    68  
    69  Just like swagger, this does not cover code generated by the toolkit. That code is entirely yours to license however you see fit.
    70  
    71  ### Licence scan on dependencies 
    72  [![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)