package openapi3 import ( "context" "errors" "fmt" "github.com/getkin/kin-openapi/jsoninfo" ) // T is the root of an OpenAPI v3 document type T struct { ExtensionProps OpenAPI string `json:"openapi" yaml:"openapi"` // Required Components Components `json:"components,omitempty" yaml:"components,omitempty"` Info *Info `json:"info" yaml:"info"` // Required Paths Paths `json:"paths" yaml:"paths"` // Required Security SecurityRequirements `json:"security,omitempty" yaml:"security,omitempty"` Servers Servers `json:"servers,omitempty" yaml:"servers,omitempty"` Tags Tags `json:"tags,omitempty" yaml:"tags,omitempty"` ExternalDocs *ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"` } func (doc *T) MarshalJSON() ([]byte, error) { return jsoninfo.MarshalStrictStruct(doc) } func (doc *T) UnmarshalJSON(data []byte) error { return jsoninfo.UnmarshalStrictStruct(data, doc) } func (doc *T) AddOperation(path string, method string, operation *Operation) { paths := doc.Paths if paths == nil { paths = make(Paths) doc.Paths = paths } pathItem := paths[path] if pathItem == nil { pathItem = &PathItem{} paths[path] = pathItem } pathItem.SetOperation(method, operation) } func (doc *T) AddServer(server *Server) { doc.Servers = append(doc.Servers, server) } func (value *T) Validate(ctx context.Context) error { if value.OpenAPI == "" { return errors.New("value of openapi must be a non-empty string") } // NOTE: only mention info/components/paths/... key in this func's errors. { wrap := func(e error) error { return fmt.Errorf("invalid components: %v", e) } if err := value.Components.Validate(ctx); err != nil { return wrap(err) } } { wrap := func(e error) error { return fmt.Errorf("invalid info: %v", e) } if v := value.Info; v != nil { if err := v.Validate(ctx); err != nil { return wrap(err) } } else { return wrap(errors.New("must be an object")) } } { wrap := func(e error) error { return fmt.Errorf("invalid paths: %v", e) } if v := value.Paths; v != nil { if err := v.Validate(ctx); err != nil { return wrap(err) } } else { return wrap(errors.New("must be an object")) } } { wrap := func(e error) error { return fmt.Errorf("invalid security: %v", e) } if v := value.Security; v != nil { if err := v.Validate(ctx); err != nil { return wrap(err) } } } { wrap := func(e error) error { return fmt.Errorf("invalid servers: %v", e) } if v := value.Servers; v != nil { if err := v.Validate(ctx); err != nil { return wrap(err) } } } return nil }