2021-03-01 00:08:33 +01:00
|
|
|
# Validation helpers
|
|
|
|
|
[](https://travis-ci.org/go-openapi/validate)
|
|
|
|
|
[](https://ci.appveyor.com/project/fredbi/validate/branch/master)
|
|
|
|
|
[](https://codecov.io/gh/go-openapi/validate)
|
|
|
|
|
[](https://slackin.goswagger.io)
|
2019-09-04 21:53:54 +02:00
|
|
|
[](https://raw.githubusercontent.com/go-openapi/validate/master/LICENSE)
|
2021-03-01 00:08:33 +01:00
|
|
|
[](https://pkg.go.dev/github.com/go-openapi/validate)
|
2019-09-04 21:53:54 +02:00
|
|
|
[](https://goreportcard.com/report/github.com/go-openapi/validate)
|
2021-01-28 17:56:38 +01:00
|
|
|
|
|
|
|
|
This package provides helpers to validate Swagger 2.0. specification (aka OpenAPI 2.0).
|
|
|
|
|
|
|
|
|
|
Reference can be found here: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md.
|
|
|
|
|
|
|
|
|
|
## What's inside?
|
|
|
|
|
|
|
|
|
|
* A validator for Swagger specifications
|
|
|
|
|
* A validator for JSON schemas draft4
|
|
|
|
|
* Helper functions to validate individual values (used by code generated by [go-swagger](https://github.com/go-swagger/go-swagger)).
|
|
|
|
|
* Required, RequiredNumber, RequiredString
|
|
|
|
|
* ReadOnly
|
|
|
|
|
* UniqueItems, MaxItems, MinItems
|
|
|
|
|
* Enum, EnumCase
|
|
|
|
|
* Pattern, MinLength, MaxLength
|
|
|
|
|
* Minimum, Maximum, MultipleOf
|
|
|
|
|
* FormatOf
|
|
|
|
|
|
|
|
|
|
[Documentation](https://godoc.org/github.com/go-openapi/validate)
|
|
|
|
|
|
|
|
|
|
## FAQ
|
|
|
|
|
|
|
|
|
|
* 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
|
