package openapi3
import (
"context"
"errors"
"fmt"
"github.com/getkin/kin-openapi/jsoninfo"
)
type Swagger 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 (swagger *Swagger) MarshalJSON() ([]byte, error) {
return jsoninfo.MarshalStrictStruct(swagger)
}
func (swagger *Swagger) UnmarshalJSON(data []byte) error {
return jsoninfo.UnmarshalStrictStruct(data, swagger)
}
func (swagger *Swagger) AddOperation(path string, method string, operation *Operation) {
paths := swagger.Paths
if paths == nil {
paths = make(Paths)
swagger.Paths = paths
}
pathItem := paths[path]
if pathItem == nil {
pathItem = &PathItem{}
paths[path] = pathItem
}
pathItem.SetOperation(method, operation)
}
func (swagger *Swagger) AddServer(server *Server) {
swagger.Servers = append(swagger.Servers, server)
}
func (swagger *Swagger) Validate(c context.Context) error {
if swagger.OpenAPI == "" {
return errors.New("value of openapi must be a non-empty JSON 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 := swagger.Components.Validate(c); err != nil {
return wrap(err)
}
}
{
wrap := func(e error) error { return fmt.Errorf("invalid info: %v", e) }
if v := swagger.Info; v != nil {
if err := v.Validate(c); err != nil {
return wrap(err)
}
} else {
return wrap(errors.New("must be a JSON object"))
}
}
{
wrap := func(e error) error { return fmt.Errorf("invalid paths: %v", e) }
if v := swagger.Paths; v != nil {
if err := v.Validate(c); err != nil {
return wrap(err)
}
} else {
return wrap(errors.New("must be a JSON object"))
}
}
{
wrap := func(e error) error { return fmt.Errorf("invalid security: %v", e) }
if v := swagger.Security; v != nil {
if err := v.Validate(c); err != nil {
return wrap(err)
}
}
}
{
wrap := func(e error) error { return fmt.Errorf("invalid servers: %v", e) }
if v := swagger.Servers; v != nil {
if err := v.Validate(c); err != nil {
return wrap(err)
}
}
}
return nil
}