swagger

Documentation

Index

• type Definition
• type Format
• type In
• type Info
• type Method
• type Parameter
• type Path
• type Response
• type Router
• type Schema
• type SecurityDefinition
• type Swagger
• type Type

Types

type Definition

type Definition struct {
	Type       string   `json:"type,omitempty"`
	Required   []string `json:"required,omitempty"`
	Properties map[string]struct {
		Type   Type     `json:"type,omitempty"`
		Format Format   `json:"format,omitempty"`
		Enum   []string `json:"enum,omitempty"`
	} `json:"properties,omitempty"`
}

type Format

type Format string

const (
	NumberFloat    Format = "float"
	NumberDouble   Format = "double"
	NumberInt32    Format = "int32"
	NumberInt64    Format = "int64"
	StringDate     Format = "date"
	StringDateTime Format = "date-time"
	StringPassword Format = "password"
	StringBytes    Format = "byte"
	StringBinary   Format = "binary"
)

type In

type In string

const (
	InQuery   In = "query"
	InHeader  In = "header"
	InPath    In = "path"
	InForm    In = "formData"
	InBody    In = "body"
	InCookies In = "cookie"
)

type Info

type Info struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	Version     string `json:"version,omitempty"`
	Contact     struct {
		Email string `json:"email,omitempty"`
	} `json:"contact,omitempty"`
	License struct {
		Name string `json:"name,omitempty"`
		URL  string `json:"url,omitempty"`
	} `json:"license,omitempty"`
}

type Method

type Method string

const (
	GET     Method = "get"
	POST    Method = "post"
	PUT     Method = "put"
	DELETE  Method = "delete"
	OPTIONS Method = "options"
	PATCH   Method = "patch"
)

type Parameter

type Parameter struct {
	In          In       `json:"in,omitempty"`
	Name        string   `json:"name,omitempty"`
	Description string   `json:"description,omitempty"`
	Required    bool     `json:"required,omitempty"`
	Type        Type     `json:"type,omitempty"`
	Minimum     float64  `json:"minimum,omitempty"`
	Maximum     float64  `json:"maximum,omitempty"`
	Format      Format   `json:"format,omitempty"`
	Schema      []Schema `json:"schema,omitempty"`
	Items       struct {
		Type   Type   `json:"type,omitempty"`
		Format Format `json:"format,omitempty"`
	} `json:"items,omitempty"`
	CollectionFormat string `json:"collectionFormat,omitempty"`
}

type Path

type Path string

type Response

type Response struct {
	Description string `json:"description,omitempty"`
	Schema      Schema `json:"schema,omitempty"`
}

type Router

type Router struct {
	Summary     string                `json:"summary,omitempty"`
	Description string                `json:"description,omitempty"`
	Tags        []string              `json:"tags,omitempty"`
	Consumes    []string              `json:"consumes,omitempty"`
	Produces    []string              `json:"produces,omitempty"`
	Parameters  []Parameter           `json:"parameters,omitempty"`
	Responses   map[string]Response   `json:"responses,omitempty"`
	Security    []map[string][]string `json:"security,omitempty"`
}

type Schema

type Schema struct {
	Type       Type              `json:"type,omitempty"`
	Format     Format            `json:"format,omitempty"`
	Items      []Schema          `json:"items,omitempty"`
	Properties map[string]Schema `json:"properties,omitempty"`
}

type SecurityDefinition

type SecurityDefinition struct {
	Type string `json:"type,omitempty"`
	In   string `json:"in,omitempty"`
	Name string `json:"name,omitempty"`
}

type Swagger

type Swagger struct {
	SwaggerVersion string `json:"swagger,omitempty"`
	Info           Info   `json:"info,omitempty"`
	Host           string `json:"host,omitempty"`
	BasePath       string `json:"basePath,omitempty"`
	Tags           []struct {
		Name         string `json:"name,omitempty"`
		Description  string `json:"description,omitempty"`
		ExternalDocs struct {
			Description string `json:"description,omitempty"`
			URL         string `json:"url,omitempty"`
		} `json:"externalDocs,omitempty"`
	} `json:"tags,omitempty"`
	Schemes             []string                      `json:"schemes,omitempty"`
	Paths               map[Path]map[Method]Router    `json:"paths,omitempty"`
	SecurityDefinitions map[string]SecurityDefinition `json:"securityDefinitions,omitempty"`
	Definitions         map[string]Definition         `json:"definitions,omitempty"`
	ExternalDocs        struct {
		Description string `json:"description,omitempty"`
		URL         string `json:"url,omitempty"`
	} `json:"externalDocs,omitempty"`
}

type Type

type Type string

const (
	String  Type = "string"
	Int     Type = "integer"
	Number  Type = "number"
	Boolean Type = "boolean"
	Array   Type = "array"
	Object  Type = "object"
	Null    Type = "null"
)