Archived

This repository has been archived on 2024-01-04. You can view files and clone it, but cannot push or open issues or pull requests.

History

…
..
.editorconfig
.gitignore
.golangci.yml
.travis.yml
appveyor.yml
CODE_OF_CONDUCT.md
context.go
debug.go
default_validator.go
doc.go
example_validator.go
formats.go
go.mod
go.sum
helpers.go
LICENSE
object_validator.go
options.go
README.md
result.go
rexp.go
schema.go
schema_messages.go
schema_option.go
schema_props.go
slice_validator.go
spec.go
spec_messages.go
type.go
update-fixtures.sh
validator.go
values.go

README.md

Validation helpers

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).
- Required, RequiredNumber, RequiredString
- ReadOnly
- UniqueItems, MaxItems, MinItems
- Enum, EnumCase
- Pattern, MinLength, MaxLength
- Minimum, Maximum, MultipleOf
- FormatOf

Documentation

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 relates the full story.

An early attempt to support Swagger 3 may be found at: https://github.com/go-openapi/spec3