github.com/rzurga/go-swagger@v0.28.1-0.20211109195225-5d1f453ffa3a/docs/README.md (about) 1 # Swagger 2.0 [](https://circleci.com/gh/go-swagger/go-swagger) [](https://ci.appveyor.com/project/casualjim/go-swagger/branch/master) [](https://codecov.io/gh/go-swagger/go-swagger) [](https://badge.fury.io/gh/go-swagger%2Fgo-swagger) 2 [](https://slackin.goswagger.io) 3 [](https://raw.githubusercontent.com/swagger-api/swagger-spec/master/LICENSE) 4 [](http://godoc.org/github.com/go-swagger/go-swagger) 5 [](https://quay.io/repository/goswagger/swagger) 6 [](https://app.fossa.io/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger?ref=badge_shield) 7 [](https://golangci.com) 8 [](https://goreportcard.com/report/github.com/go-swagger/go-swagger) 9 10 This package contains a golang implementation of Swagger 2.0 (aka [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)): 11 it knows how to serialize and deserialize swagger specifications. 12 13 [Swagger](https://swagger.io/) is a simple yet powerful representation of your RESTful API.<br> 14 15 >  **Swagger in a nutshell** 16 > 17 > With the largest ecosystem of API tooling on the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment environment. 18 > 19 > With a Swagger-enabled API, you get interactive documentation, client SDK generation and discoverability. We created Swagger to help fulfill the promise of APIs. 20 > 21 > Swagger helps companies like Apigee, Getty Images, Intuit, LivingSocial, McKesson, Microsoft, Morningstar, and PayPal build the best possible services with RESTful APIs. Now in version 2.0, Swagger is more enabling than ever. And it's 100% open source software. 22 23 ## Features 24 `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. 25 26 * Generates a server from a swagger specification 27 * Generates a client from a swagger specification 28 * Generates a CLI (command line tool) from a swagger specification (alpha stage) 29 * Supports most features offered by jsonschema and swagger, including polymorphism 30 * Generates a swagger specification from annotated go code 31 * Additional tools to work with a swagger spec 32 * Great customization features, with vendor extensions and customizable templates 33 34 Our focus with code generation is to produce idiomatic, fast go code, which plays nice with golint, go vet etc. 35 36 ## Project status 37 `go-swagger` is now feature complete and has stabilized its API. 38 39 Most features and building blocks are now in a stable state, with a rich set of CI tests. 40 41 The go-openapi community actively continues bringing fixes and enhancements to this code base. 42 43 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). 44 45 ## Documentation 46 <https://goswagger.io> 47 48 ## FAQ 49 Q&A contributed by the community: 50 51 <https://goswagger.io/faq/> 52 53 ## How is this different from go generator in swagger-codegen? 54 **tl;dr** The main difference at this moment is that this one actually works... 55 56 The swagger-codegen project only generates a _workable_ go client and even there it will only support flat models. 57 Further, the go server generated by swagger-codegen is mostly a stub. 58 59 > **Motivation** 60 > Why is this not done as a part of the swagger-codegen project? Because: 61 > 62 > * I don't really know java very well and so I'd be learning both java and the object model of the codegen which was in heavy flux as opposed to doing go and I really wanted to go experience of designing a large codebase with it. 63 > * Go's super limited type system makes it so that it doesn't fit well in the model of swagger-codegen 64 > * Go's idea of polymorphism doesn't reconcile very well with a solution designed for languages that actually have inheritance and so forth. 65 > * For supporting types like `[][][]map[string][][]int64` I don't think it's possible with mustache 66 > 67 > I gravely underestimated the amount of work that would be involved in making something useful out of it. 68 > My personal mission: I want the jvm to go away, it was great way back when now it's just silly (vm in container on vm in vm in container) 69 70 ## What's inside? 71 72 Here is an outline of available features (see the full list [here](https://goswagger.io/features.html)): 73 74 - An object model that serializes swagger-compliant yaml or json 75 - A tool to work with swagger 76 - Serve swagger UI for any swagger spec file 77 - Flexible code generation, with customizable templates 78 - Generate go API server based on swagger spec 79 - Generate go API client from a swagger spec 80 - Validate a swagger spec document, with extra rules outlined [here](https://github.com/apigee-127/sway/blob/master/docs/README.md#semantic-validation) 81 - Generate a spec document based on annotated code 82 - A runtime to work with Rest API and middlewares 83 - Serve spec 84 - Routing 85 - Validation 86 - Authorization 87 - Swagger docs UI 88 - A Diff tool which will cause a build to fail if a change in the spec breaks backwards compatibility 89 90 There is more to that... 91 92 - A [typed JSON Schema implementation](https://goswagger.io/use/model.html), supporting most Draft 4 features 93 - Extended string and numeric formats: [strfmt](https://github.com/go-openapi/strfmt) 94 - Utilities to work with JSON, convert data types and pointers: [swag](https://github.com/go-openapi/swag) 95 - A jsonschema (Draft 4) validator, with full $ref support: [validate](https://github.com/go-openapi/validate) 96 - Custom validation interface 97 98 ## Installing 99 `go-swagger` is available as binary or docker releases as well as from source: [more details](https://goswagger.io/install.html). 100 101 ## Use-cases 102 The main package of the toolkit, go-swagger/go-swagger, provides command line tools to help working with swagger. 103 104 The toolkit is highly customizable and allows endless possibilities to work with OpenAPI2.0 specifications. 105 106 Beside the go-swagger CLI tool and generator, the [go-openapi packages](https://github.com/go-openapi) provide modular functionality to build custom solutions on top of OpenAPI. 107 108 The CLI supports shell autocompletion utilities: see [here](https://goswagger.io/cli_helpers.html). 109 110 ### Serve specification UI 111 Most basic use-case: serve a UI for your spec: 112 113 ``` 114 swagger serve https://raw.githubusercontent.com/swagger-api/swagger-spec/master/examples/v2.0/json/petstore-expanded.json 115 ``` 116 117 ### Validate a specification 118 To [validate](https://goswagger.io/usage/validate.html) a Swagger specification: 119 120 ``` 121 swagger validate https://raw.githubusercontent.com/swagger-api/swagger-spec/master/examples/v2.0/json/petstore-expanded.json 122 ``` 123 124 ### Generate an API server 125 To generate a [server for a swagger spec](https://goswagger.io/generate/server.html) document: 126 127 ``` 128 swagger generate server [-f ./swagger.json] -A [application-name [--principal [principal-name]] 129 ``` 130 131 ### Generate an API client 132 To generate a [client for a swagger spec](https://goswagger.io/generate/client.html) document: 133 134 ``` 135 swagger generate client [-f ./swagger.json] -A [application-name [--principal [principal-name]] 136 ``` 137 ### Generate an CLI (Command line tool) 138 To generate a [CLI for a swagger spec](https://github.com/go-swagger/go-swagger/tree/master/examples/cli) document: 139 ``` 140 swagger generate cli [-f ./swagger.json] -A [application-name [--principal [principal-name]] 141 ``` 142 ### Generate a spec from source 143 To generate a [swagger spec document for a go application](https://goswagger.io/generate/spec.html): 144 145 ``` 146 swagger generate spec -o ./swagger.json 147 ``` 148 149 ### Generate a data model 150 To generate model structures and validators exposed by the API: 151 152 ``` 153 swagger generate model --spec={spec} 154 ``` 155 156 ### Transform specs 157 158 There are [several commands](https://goswagger.io/use/transform.html) allowing you to transform your spec. 159 160 Resolve and expand $ref's in your spec as inline definitions: 161 ``` 162 swagger expand {spec} 163 ``` 164 165 Flatten your spec: all external $ref's are imported into the main document and inline schemas reorganized as definitions. 166 ``` 167 swagger flatten {spec} 168 ``` 169 170 Merge specifications (composition): 171 ``` 172 swagger mixin {spec1} {spec2} 173 ``` 174 175 ### Compare specs 176 177 The diff command allows you to check backwards compatibility. 178 Type ```swagger diff --help``` for info. 179 180 ``` 181 swagger diff {spec1} {spec2} 182 ``` 183 184 ### Generate spec markdown spec 185 186 ``` 187 swagger generate markdown -f {spec} --output swagger.mode 188 ``` 189 190 ## Try it 191 192 Try `go-swagger` in a free online workspace using Gitpod: 193 194 [](https://gitpod.io#https://github.com/go-swagger/go-swagger) 195 196 ## Licensing 197 198 The toolkit itself is licensed as 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. 199 200 201 [](https://app.fossa.io/projects/git%2Bgithub.com%2Fgo-swagger%2Fgo-swagger?ref=badge_large) 202 203 ## Who is using this project? 204 205 To name but a few... (feel free to sign in there if you are using this project): 206 207 > In the list below, we tried to figure out the public repos where you'll find examples on how to use `go-swagger` and `go-openapi`: 208 209 [3DSIM](https://github.com/3DSIM) 210 [Alibaba PouchAPI](https://github.com/alibaba/pouch) 211 [CheckR](https://github.com/checkr/flagr) 212 [Cilium](https://github.com/cilium/cilium) 213 [CoreOS](https://github.com/coreos/go-quay) 214 [NetBox Community](https://github.com/netbox-community/go-netbox) 215 [EVE Central](https://github.com/evecentral) 216 Iron.io 217 [JaegerTracing](https://github.com/jaegertracing/jaeger) 218 [Kubernetes-Helm](https://github.com/kubernetes-helm/monocular) 219 [Kubernetes](https://godoc.org/k8s.io/apiextensions-apiserver/pkg/apiserver) 220 [ManifoldCo](https://github.com/manifoldco) 221 [Metaparticle.io](https://github.com/metaparticle-io/metaparticle-ast) 222 [Netlify](https://github.com/netlify/open-api) 223 [Nutanix](https://github.com/nutanix) 224 [OAS2](https://github.com/hypnoglow/oas2) 225 [OVH API](https://github.com/appscode/go-ovh) 226 [RackHD](https://github.com/RackHD/RackHD) 227 [ScaleFT](https://github.com/authclub/billforward) 228 [StratoScale](https://github.com/Stratoscale/swagger) 229 [Terraform Provider OpenAPI](https://github.com/dikhan/terraform-provider-openapi) 230 [VMware](https://github.com/vmware/dispatch) 231 ... 232 233 ## Note to users migrating from older releases 234 235 ### Migrating from 0.25 to [master] 236 237 Changes in the behavior of the generated client regarding defaults in parameters and response headers: 238 239 * default values for parameters are no more hydrated by default and sent over the wire 240 (assuming the server uses defaults). 241 * the previous behavior (explicitly sending defaults over the wire) can be obtained 242 with the SetDefaults() and WithDefaults() parameter methods. 243 * the body parameter is not pre-hydrated with the default from it schema 244 * default values for response headers are hydrated when the header is not received 245 (previously, headers remained with their zero value) 246 247 ### Migrating from 0.24 to 0.25 248 249 The options for `generate model --all-definitions` and `--skip-struct` are marked for deprecation. 250 251 For now, the CLI continues to accept these options. They will be removed in a future version. 252 253 Generating all definitions is now the default behavior when no other option filters the generation scope. 254 The `--skip-struct` option had no effect. 255 256 ### Migrating from 0.14 to 0.15 257 258 Generated servers no more import the following package (replaced by go1.8 native functionality): 259 ``` 260 github.com/tylerb/graceful 261 ``` 262 263 Spec flattening now defaults to minimal changes to models and should be workable for 0.12 users. 264 265 Users who prefer to stick to 0.13 and 0.14 default flattening mode may now use the `--with-flatten=full` option. 266 267 Note that the `--skip-flatten` option has been phased out and replaced by the more explicit `--with-expand` option. 268 269 ### Migrating from 0.12 to 0.13 270 271 Spec flattening and $ref resolution brought breaking changes in model generation, since all complex things generate their own definitions. 272 273 ### Migrating from 0.5.0 to 0.6.0 274 275 You will have to rename some imports: 276 277 ``` 278 github.com/go-swagger/go-swagger/httpkit/validate to github.com/go-openapi/validate 279 github.com/go-swagger/go-swagger/httpkit to github.com/go-openapi/runtime 280 github.com/naoina/denco to github.com/go-openapi/runtime/middleware/denco 281 github.com/go-swagger/go-swagger to github.com/go-openapi 282 ``` 283 284 ### Using 0.5.0 285 286 Because 0.5.0 and master have diverged significantly, you should checkout the tag 0.5.0 for go-swagger when you use the currently released version.