1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
|
package main
import (
"flag"
"log"
"os"
"strings"
"github.com/invopop/yaml"
"github.com/getkin/kin-openapi/openapi2"
"github.com/getkin/kin-openapi/openapi3"
)
var (
defaultCircular = openapi3.CircularReferenceCounter
circular = flag.Int("circular", defaultCircular, "bump this (upper) limit when there's trouble with cyclic schema references")
)
var (
defaultDefaults = true
defaults = flag.Bool("defaults", defaultDefaults, "when false, disables schemas' default field validation")
)
var (
defaultExamples = true
examples = flag.Bool("examples", defaultExamples, "when false, disables all example schema validation")
)
var (
defaultExt = false
ext = flag.Bool("ext", defaultExt, "enables visiting other files")
)
var (
defaultPatterns = true
patterns = flag.Bool("patterns", defaultPatterns, "when false, allows schema patterns unsupported by the Go regexp engine")
)
func main() {
flag.Parse()
filename := flag.Arg(0)
if len(flag.Args()) != 1 || filename == "" {
log.Fatalf("Usage: go run github.com/getkin/kin-openapi/cmd/validate@latest [--circular] [--defaults] [--examples] [--ext] [--patterns] -- <local YAML or JSON file>\nGot: %+v\n", os.Args)
}
data, err := os.ReadFile(filename)
if err != nil {
log.Fatal(err)
}
var vd struct {
OpenAPI string `json:"openapi" yaml:"openapi"`
Swagger string `json:"swagger" yaml:"swagger"`
}
if err := yaml.Unmarshal(data, &vd); err != nil {
log.Fatal(err)
}
switch {
case vd.OpenAPI == "3" || strings.HasPrefix(vd.OpenAPI, "3."):
openapi3.CircularReferenceCounter = *circular
loader := openapi3.NewLoader()
loader.IsExternalRefsAllowed = *ext
var doc *openapi3.T
if filename == "-" {
doc, err = loader.LoadFromStdin()
} else {
doc, err = loader.LoadFromFile(filename)
}
if err != nil {
log.Fatalln("Loading error:", err)
}
var opts []openapi3.ValidationOption
if !*defaults {
opts = append(opts, openapi3.DisableSchemaDefaultsValidation())
}
if !*examples {
opts = append(opts, openapi3.DisableExamplesValidation())
}
if !*patterns {
opts = append(opts, openapi3.DisableSchemaPatternValidation())
}
if err = doc.Validate(loader.Context, opts...); err != nil {
log.Fatalln("Validation error:", err)
}
case vd.OpenAPI == "2" || strings.HasPrefix(vd.OpenAPI, "2."),
vd.Swagger == "2" || strings.HasPrefix(vd.Swagger, "2."):
if *circular != defaultCircular {
log.Fatal("Flag --circular is only for OpenAPIv3")
}
if *defaults != defaultDefaults {
log.Fatal("Flag --defaults is only for OpenAPIv3")
}
if *examples != defaultExamples {
log.Fatal("Flag --examples is only for OpenAPIv3")
}
if *ext != defaultExt {
log.Fatal("Flag --ext is only for OpenAPIv3")
}
if *patterns != defaultPatterns {
log.Fatal("Flag --patterns is only for OpenAPIv3")
}
var doc openapi2.T
if err := yaml.Unmarshal(data, &doc); err != nil {
log.Fatalln("Loading error:", err)
}
default:
log.Fatal("Missing or incorrect 'openapi' or 'swagger' field")
}
}
|