diff options
Diffstat (limited to 'vendor/github.com/go-openapi/spec/README.md')
-rw-r--r-- | vendor/github.com/go-openapi/spec/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/vendor/github.com/go-openapi/spec/README.md b/vendor/github.com/go-openapi/spec/README.md new file mode 100644 index 000000000..18782c6da --- /dev/null +++ b/vendor/github.com/go-openapi/spec/README.md @@ -0,0 +1,34 @@ +# OAI object model + +[](https://travis-ci.org/go-openapi/spec) +<!-- [](https://ci.appveyor.com/project/casualjim/go-openapi/spec/branch/master) --> +[](https://codecov.io/gh/go-openapi/spec) +[](https://slackin.goswagger.io) +[](https://raw.githubusercontent.com/go-openapi/spec/master/LICENSE) +[](https://pkg.go.dev/github.com/go-openapi/spec) +[](https://goreportcard.com/report/github.com/go-openapi/spec) + +The object model for OpenAPI specification documents. + +### FAQ + +* What does this do? + +> 1. This package knows how to marshal and unmarshal Swagger API specifications into a golang object model +> 2. It knows how to resolve $ref and expand them to make a single root document + +* How does it play with the rest of the go-openapi packages ? + +> 1. This package is at the core of the go-openapi suite of packages and [code generator](https://github.com/go-swagger/go-swagger) +> 2. There is a [spec loading package](https://github.com/go-openapi/loads) to fetch specs as JSON or YAML from local or remote locations +> 3. There is a [spec validation package](https://github.com/go-openapi/validate) built on top of it +> 4. There is a [spec analysis package](https://github.com/go-openapi/analysis) built on top of it, to analyze, flatten, fix and merge spec documents + +* Does this library support OpenAPI 3? + +> No. +> This package currently only supports OpenAPI 2.0 (aka Swagger 2.0). +> There is no plan to make it evolve toward supporting OpenAPI 3.x. +> This [discussion thread](https://github.com/go-openapi/spec/issues/21) relates the full story. +> +> An early attempt to support Swagger 3 may be found at: https://github.com/go-openapi/spec3 |