swagger

Documentation

Index

• type Contact
• type ExternalDocs
• type License
• type Properties
• type Swagger
  • func BuildSwagger(node node.Node) (swagger Swagger, err error)
  • func (s *Swagger) SaveJSON(path string) (err error)

Types

type Contact

type Contact struct {
	Name  string `json:"name,omitempty" yaml:"name,omitempty"`
	URL   string `json:"url,omitempty" yaml:"url,omitempty"`
	Email string `json:"email,omitempty" yaml:"email,omitempty"`
}

type ExternalDocs

type ExternalDocs struct {
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	URL         string `json:"url,omitempty" yaml:"url,omitempty"`
}

type License

type License struct {
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
	URL  string `json:"url,omitempty" yaml:"url,omitempty"`
}

type Properties

type Properties map[string]schema

type Swagger

type Swagger struct {
	OpenAPI    string          `json:"openapi" yaml:"openapi"`
	Info       info            `json:"info,omitempty" yaml:"info,omitempty"`
	Servers    []server        `json:"servers,omitempty" yaml:"servers,omitempty"`
	Tags       []tag           `json:"tags,omitempty" yaml:"tags,omitempty"`
	Schemes    []string        `json:"schemes,omitempty" yaml:"schemes,omitempty"`
	Paths      map[string]path `json:"paths" yaml:"paths"`
	Components components      `json:"components,omitempty" yaml:"components,omitempty"`
}

func BuildSwagger

func BuildSwagger(node node.Node) (swagger Swagger, err error)

func (*Swagger) SaveJSON

func (s *Swagger) SaveJSON(path string) (err error)