You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
techknowlogick 47f6a4ec3f
go1.16 (#14783)
3 years ago
..
.editorconfig Use vendored go-swagger (#8087) 5 years ago
.gitignore Use vendored go-swagger (#8087) 5 years ago
.golangci.yml Vendor Update (#14496) 3 years ago
.travis.yml Vendor Update (#14496) 3 years ago
CODE_OF_CONDUCT.md Use vendored go-swagger (#8087) 5 years ago
LICENSE Use vendored go-swagger (#8087) 5 years ago
README.md go1.16 (#14783) 3 years ago
appveyor.yml go1.16 (#14783) 3 years ago
context.go Vendor Update (#14496) 3 years ago
debug.go Use vendored go-swagger (#8087) 5 years ago
default_validator.go Vendor Update (#14496) 3 years ago
doc.go Use vendored go-swagger (#8087) 5 years ago
example_validator.go Vendor Update (#14496) 3 years ago
formats.go [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 4 years ago
go.mod go1.16 (#14783) 3 years ago
go.sum go1.16 (#14783) 3 years ago
helpers.go Vendor Update (#14496) 3 years ago
object_validator.go Vendor Update (#14496) 3 years ago
options.go Use vendored go-swagger (#8087) 5 years ago
result.go [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 4 years ago
rexp.go Vendor Update (#14496) 3 years ago
schema.go Vendor Update (#14496) 3 years ago
schema_messages.go Use vendored go-swagger (#8087) 5 years ago
schema_option.go [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 4 years ago
schema_props.go Vendor Update (#14496) 3 years ago
slice_validator.go [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 4 years ago
spec.go Vendor Update (#14496) 3 years ago
spec_messages.go Vendor Update (#14496) 3 years ago
type.go Vendor Update (#14496) 3 years ago
update-fixtures.sh Use vendored go-swagger (#8087) 5 years ago
validator.go Vendor Update (#14496) 3 years ago
values.go Vendor Update (#14496) 3 years ago

README.md

Validation helpers

Build Status Build status codecov Slack Status license Go Reference Go Report Card

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