swagger

Documentation

Index

• Constants
• Variables
• type API
• type Definition
• type Info
• type Parameter
• type Position
• type Swagger
  • func New(p *protoc.Package) *Swagger
  • func (s *Swagger) Generater() *pluginpb.CodeGeneratorResponse_File
• type Tag

Constants

const DefaultAPIHost = "127.0.0.1"

const SwaggerVersion = "2.0"

Variables

var DefaultSchemes = []string{"http", "https"}

Types

type API

type API struct {
	// Tags tag name list
	Tags []string `json:"tags,omitempty"`
	// Summary summary
	Summary string `json:"summary,omitempty"`
	// Description description
	Description string `json:"description,omitempty"`
	// OperationID operationId
	OperationID string `json:"operationId,omitempty"`
	// Consumes request ContentType
	Consumes []string `json:"consumes,omitempty"`
	// Produces response ContentType
	Produces []string `json:"produces,omitempty"`
	// Parameters request
	Parameters []*Parameter `json:"parameters,omitempty"`
	// Responses response
	Responses map[string]*Parameter `json:"responses,omitempty"`
}

API .

type Definition

type Definition struct {
	// Name name
	Name string `json:"-"`
	// Type json type
	Type string `json:"type,omitempty"`
	// Description description
	Description string `json:"description,omitempty"`

	// Format data type
	Format string `json:"format,omitempty"`

	// Enum enum keys
	Enum []string `json:"enum,omitempty"`
	// Default enum default
	Default string `json:"default,omitempty"`

	// Reflex others Definition point
	Reflex string `json:"$ref,omitempty"`

	// Items array info
	Items *Definition `json:"items,omitempty"`

	// Entry proto entry type
	Entry *Definition `json:"additionalProperties,omitempty"`

	// Nesteds nested
	Nesteds map[string]*Definition `json:"properties,omitempty"`
}

Definition model

type Info

type Info struct {
	// Title api title
	Title string `json:"title,omitempty"`
	// Version api version
	Version string `json:"version,omitempty"`
	// Description api description
	Description string `json:"description,omitempty"`
}

Info service info

type Parameter

type Parameter struct {
	In       Position `json:"in,omitempty"`
	Name     string   `json:"name,omitempty"`
	Type     string   `json:"type,omitempty"`
	Required bool     `json:"required,omitempty"`
	// Enum enum keys
	Enum []string `json:"enum,omitempty"`
	// Default default value
	Default string `json:"default,omitempty"`
	// Description description
	Description string `json:"description,omitempty"`
	// Schema Definition path
	Schema *Definition `json:"schema,omitempty"`
	// Items array info
	Items *Definition `json:"items,omitempty"`
}

Parameter .

type Position

type Position string

const (
	PositionFormData Position = "formData"
	PositionHeader   Position = "header"
	PositionQuery    Position = "query"
	PositionBody     Position = "body"
	PositionPath     Position = "path"
)

type Swagger

type Swagger struct {

	// Swagger version
	Swagger string `json:"swagger,omitempty"`
	// Info service info
	Info *Info `json:"info,omitempty"`
	// Host service host
	Host string `json:"host,omitempty"`
	// BasePath uri prefix
	BasePath string `json:"basePath,omitempty"`
	// Tags router group list
	Tags []*Tag `json:"tags,omitempty"`
	// Schemes scheme HTTP and HTTPS
	Schemes []string `json:"schemes,omitempty"`
	// Paths api list. map[uri][method]*API
	Paths map[string]map[string]*API `json:"paths,omitempty"`
	// Definitions model list
	Definitions map[string]*Definition `json:"definitions,omitempty"`
	// contains filtered or unexported fields
}

Swagger .

func New

func New(p *protoc.Package) *Swagger

New .

func (*Swagger) Generater

func (s *Swagger) Generater() *pluginpb.CodeGeneratorResponse_File

Generater .

type Tag

type Tag struct {
	// Name group name
	Name string `json:"name,omitempty"`
	// Description tag description
	Description string `json:"description,omitempty"`
}

Tag router group