swagger

Documentation

Index

• type SwaggerClass
  • func GetSwaggerInstance() *SwaggerClass
  • func (this *SwaggerClass) GeneSwagger(hostAndPort string, filename string, type_ string)
• type Yaml_Definition
• type Yaml_Info
• type Yaml_Parameter
• type Yaml_Path
• type Yaml_Property
• type Yaml_Response
• type Yaml_Swagger
• type Yaml_Tag

Types

type SwaggerClass

type SwaggerClass struct {
}

func GetSwaggerInstance

func GetSwaggerInstance() *SwaggerClass

func (*SwaggerClass) GeneSwagger

func (this *SwaggerClass) GeneSwagger(hostAndPort string, filename string, type_ string)

type Yaml_Definition

type Yaml_Definition struct {
	Type       string                   `json:"type,omitempty" yaml:"type,omitempty"`
	Required   []string                 `json:"required,omitempty" yaml:"required,omitempty"`
	Properties map[string]Yaml_Property `json:"properties" yaml:"properties"`
}

type Yaml_Info

type Yaml_Info struct {
	Description string `json:"description" yaml:"description"`
	Version     string `json:"version" yaml:"version"`
	Title       string `json:"title" yaml:"title"`
}

type Yaml_Parameter

type Yaml_Parameter struct {
	In          string            `json:"in" yaml:"in"`
	Name        string            `json:"name" yaml:"name"`
	Required    bool              `json:"required" yaml:"required"`
	Description string            `json:"description" yaml:"description"`
	Type        string            `json:"type,omitempty" yaml:"type,omitempty"`
	Schema      map[string]string `json:"schema,omitempty" yaml:"schema,omitempty"`
}

type Yaml_Path

type Yaml_Path struct {
	Tags        []string                 `json:"tags" yaml:"tags"`
	Summary     string                   `json:"summary" yaml:"summary"`
	Consumes    []string                 `json:"consumes" yaml:"consumes"`
	Produces    []string                 `json:"produces" yaml:"produces"`
	Parameters  []Yaml_Parameter         `json:"parameters" yaml:"parameters"`
	Responses   map[string]Yaml_Response `json:"responses" yaml:"responses"`
	Description string                   `json:"description" yaml:"description"`
}

type Yaml_Property

type Yaml_Property struct {
	Type        string                   `json:"type,omitempty" yaml:"type,omitempty"`
	Example     interface{}              `json:"example,omitempty" yaml:"example,omitempty"`
	Ref         string                   `json:"$ref,omitempty" yaml:"$ref,omitempty"`
	Items       map[string]interface{}   `json:"items,omitempty" yaml:"items,omitempty"`
	Description string                   `json:"description" yaml:"description"`
	Properties  map[string]Yaml_Property `json:"properties,omitempty" yaml:"properties,omitempty"`
}

type Yaml_Response

type Yaml_Response struct {
	Description string                 `json:"description" yaml:"description"`
	Schema      map[string]interface{} `json:"schema,omitempty" yaml:"schema,omitempty"`
}

type Yaml_Swagger

type Yaml_Swagger struct {
	Swagger     string                          `json:"swagger" yaml:"swagger"`
	Info        Yaml_Info                       `json:"info" yaml:"info"`
	Host        string                          `json:"host" yaml:"host"`
	BasePath    string                          `json:"basePath" yaml:"basePath"`
	Tags        []Yaml_Tag                      `json:"tags" yaml:"tags"`
	Schemes     []string                        `json:"schemes" yaml:"schemes"`
	Paths       map[string]map[string]Yaml_Path `json:"paths" yaml:"paths"`
	Definitions map[string]Yaml_Definition      `json:"definitions" yaml:"definitions"`
}

type Yaml_Tag

type Yaml_Tag struct {
	Name        string `json:"name" yaml:"name"`
	Description string `json:"description" yaml:"description"`
}