openapi

Documentation

Index

• type Component
• type Contact
• type Info
• type License
• type OpenApi
  • func BuildOpenApi(comments in.SwagifyComment) OpenApi

Types

type Component

type Component struct {
	Parameters      map[string]par.Parameter      `json:"parameters" yaml:"parameters"`
	Schemas         map[string]sch.Schema         `json:"schemas" yaml:"schemas"`
	Responses       map[string]res.Response       `json:"responses" yaml:"responses"`
	RequestBodies   map[string]req.RequestBody    `json:"requestBodies" yaml:"requestBodies"`
	SecuritySchemes map[string]sec.SecurityScheme `json:"securitySchemes" yaml:"securitySchemes"`
}

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 Info

type Info struct {
	Title          string `json:"title,omitempty" yaml:"title,omitempty"`
	Description    string `json:"description,omitempty" yaml:"description,omitempty"`
	TermsOfService string `json:"termsOfService,omitempty" yaml:"termsOfService,omitempty"`
	Contact        `json:"contact,omitempty" yaml:"contact,omitempty"`
	License        `json:"license,omittempty" yaml:"license,omitempty"`
	Version        string `json:"version" yaml:"version"`
}

type License

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

type OpenApi

type OpenApi struct {
	Version    string `json:"openapi" yaml:"openapi"`
	Info       `json:"info" yaml:"info"`
	Servers    []ser.Server          `json:"servers,omitempty" yaml:"servers,omitempty"`
	Paths      map[string]pat.Path   `json:"paths" yaml:"paths"`
	Components Component             `json:"components" yaml:"components"`
	Security   []map[string][]string `json:"security,omitempty" yaml:"security,omitempty"`
}

func BuildOpenApi

func BuildOpenApi(comments in.SwagifyComment) OpenApi