models

Documentation

Index

• type Col
• type Field
  • func (f *Field) AsParamName() string
• type GenerateFileDesc
• type Import
  • func (cip *Import) GetPath() string
  • func (cip *Import) Init(importPath string) *Import
  • func (cip *Import) IsEmpty() bool
  • func (cip *Import) IsSame(i *Import) bool
• type Key
  • func (k *Key) GetFieldNameCombine() string
• type Kv
• type SwaggerApis
  • func (sa *SwaggerApis) AddRoute(path, method string, route *SwaggerRoute)
  • func (sa *SwaggerApis) AsDoc(paramsMap map[string]*SwaggerMessage) map[string]interface{}
• type SwaggerAuth
• type SwaggerDoc
  • func (sd *SwaggerDoc) AddService(name string, service *SwaggerApis)
  • func (sd *SwaggerDoc) AsDoc(paramsMap map[string]*SwaggerMessage) map[string]interface{}
• type SwaggerMessage
  • func (swaggerMessage *SwaggerMessage) AsDef() interface{}
  • func (swaggerMessage *SwaggerMessage) AsRequest(location string) interface{}
  • func (swaggerMessage *SwaggerMessage) AsResponse() interface{}
• type SwaggerMessageField
  • func (swaggerField *SwaggerMessageField) AsDefinition() map[string]interface{}
  • func (swaggerField *SwaggerMessageField) AsRequest(location string) interface{}
• type SwaggerMessageRef
• type SwaggerRoute
  • func (sr *SwaggerRoute) AsDoc(paramsMap map[string]*SwaggerMessage) map[string]interface{}
• type SwaggerTag
• type Tag
  • func (t *Tag) GetTagValue(by string) string

Types

type Col

type Col struct {
	ColName string
	*Field
}

type Field

type Field struct {
	Name   string
	GoType string
}

func (*Field) AsParamName

func (f *Field) AsParamName() string

type GenerateFileDesc

type GenerateFileDesc struct {
	Name        string
	Content     string
	CheckExists bool
}

type Import

type Import struct {
	Alias      string
	ImportPath string
}

func (*Import) GetPath

func (cip *Import) GetPath() string

func (*Import) Init

func (cip *Import) Init(importPath string) *Import

func (*Import) IsEmpty

func (cip *Import) IsEmpty() bool

func (*Import) IsSame

func (cip *Import) IsSame(i *Import) bool

type Key

type Key struct {
	// this represents from field and type
	KeyName string
	KeyType generated.DBKeyType
	Fields  []*Field
}

func (*Key) GetFieldNameCombine

func (k *Key) GetFieldNameCombine() string

type Kv

type Kv struct {
	Key   string
	Value string
}

type SwaggerApis

type SwaggerApis struct {
	Tags       []*SwaggerTag `json:"tags"`
	BasePath   string        `json:"basePath"`
	Containers map[string]map[string]*SwaggerRoute
}

func (*SwaggerApis) AddRoute

func (sa *SwaggerApis) AddRoute(path, method string, route *SwaggerRoute)

func (*SwaggerApis) AsDoc

func (sa *SwaggerApis) AsDoc(paramsMap map[string]*SwaggerMessage) map[string]interface{}

type SwaggerAuth

type SwaggerAuth struct {
	Name    string   `json:"name"`
	Scope   []string `json:"scope"`
	Schemes []string `json:"schemes"`
}

type SwaggerDoc

type SwaggerDoc struct {
	Tags []*SwaggerTag           `json:"tags"`
	Auth []*SwaggerAuth          `json:"auth"`
	Host string                  `json:"host"`
	Apis map[string]*SwaggerApis `json:"apis"`
	Loc  string                  `json:"loc"`
}

func (*SwaggerDoc) AddService

func (sd *SwaggerDoc) AddService(name string, service *SwaggerApis)

func (*SwaggerDoc) AsDoc

func (sd *SwaggerDoc) AsDoc(paramsMap map[string]*SwaggerMessage) map[string]interface{}

type SwaggerMessage

type SwaggerMessage struct {
	Name        string                 `json:"name"`
	Type        string                 `json:"type"`
	Required    []string               `json:"required"`
	Properties  []*SwaggerMessageField `json:"properties"`
	Identify    string                 `json:"identify"`
	Description string                 `json:"description"`
}

func (*SwaggerMessage) AsDef

func (swaggerMessage *SwaggerMessage) AsDef() interface{}

func (*SwaggerMessage) AsRequest

func (swaggerMessage *SwaggerMessage) AsRequest(location string) interface{}

func (*SwaggerMessage) AsResponse

func (swaggerMessage *SwaggerMessage) AsResponse() interface{}

type SwaggerMessageField

type SwaggerMessageField struct {
	Name        string          `json:"name"`
	Description string          `json:"description"`
	Required    bool            `json:"required"`
	Type        string          `json:"-"`
	IsSlice     bool            `json:"-"`
	Enum        []string        `json:"enum,omitempty"`
	Example     string          `json:"example,omitempty"`
	Format      string          `json:"format,omitempty"`
	Identify    string          `json:"-"`
	Refer       *SwaggerMessage `json:"ref,omitempty"`
}

func (*SwaggerMessageField) AsDefinition

func (swaggerField *SwaggerMessageField) AsDefinition() map[string]interface{}

func (*SwaggerMessageField) AsRequest

func (swaggerField *SwaggerMessageField) AsRequest(location string) interface{}

type SwaggerMessageRef

type SwaggerMessageRef struct {
	FullName string `json:"full_name"`
	Location string `json:"location"`
}

type SwaggerRoute

type SwaggerRoute struct {
	Description string   `json:"description"`
	OperationId string   `json:"operationId"`
	Consumes    []string `json:"consumes"`
	Produces    []string `json:"produces"`

	Requests  *SwaggerMessageRef `json:"requests"`
	Responses *SwaggerMessageRef `json:"responses"`
}

func (*SwaggerRoute) AsDoc

func (sr *SwaggerRoute) AsDoc(paramsMap map[string]*SwaggerMessage) map[string]interface{}

type SwaggerTag

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

type Tag

type Tag struct {
	KV     *Kv
	Mapper func(s string) string
}

func (*Tag) GetTagValue

func (t *Tag) GetTagValue(by string) string