path

Documentation

Index

• Constants
• func GetKnownObjects() map[string]*Object
• func SaveObject(name string, obj reflect.Type, withArray bool, withCU bool) (err error)
• func StructType(v any) (t reflect.Type, err error)
• type Chain
  • func (chain *Chain) Clone() *Chain
• type Chains
  • func (chains *Chains) Clone() *Chains
  • func (chains *Chains) Find(path []string) (matched *Chain, pathParams any, code int, err error)
  • func (chains *Chains) Len() int
  • func (chains *Chains) Less(i, j int) bool
  • func (chains *Chains) Prepare(m string) (err error)
  • func (c *Chains) Swap(i, j int)
• type ChainsList
  • func (chainsList ChainsList) Clone() ChainsList
• type Flags
• type Methods
• type Object
• type Params
  • func (p *Params) ExtractFieldsFromBody(body []byte) (fieldsSlice []misc.InterfaceMap, allMessages [][]string, err error)
  • func (p *Params) MakeTypeFlatModel() (err error)
  • func (p *Params) Prepare(m string, msgs *misc.Messages) (err error)
• type ParamsObject
• type RequestParams
• type ResponseParams
• type Set
  • func (set *Set) Clone() *Set
  • func (set *Set) Find(m string, path []string) (matched *Chain, pathParams any, result any, code int, err error)
  • func (set *Set) Prepare() (err error)
• type Token
  • func (token *Token) Clone() *Token
• type Vars

Constants

const (
	NoFlags = Flags(0x00000000)

	FlagResponseHashed           = Flags(0x00000001)
	FlagRequestDontMakeFlatModel = Flags(0x00000002)
	FlagResponseIsNotArray       = Flags(0x00000004)
	FlagUDqueriesReturnsID       = Flags(0x00000008)
	FlagWithoutCU                = Flags(0x00000010)
	FlagBodyReaderNeeded         = Flags(0x00000020)

	FlagChainDefault    = Flags(0x00000001)
	FlagChainEnableTail = Flags(0x00000002)

	// VarName
	VarIgnore = "_"
	VarID     = "ID"
	VarGUID   = "GUID"
	VarName   = "Name"
	VarStatus = "Status"

	// Имена тегов полей в описании query параметров
	TagJSON     = "json"
	TagDB       = db.TagDB      // Database field definition
	TagDBAlt    = db.TagDBAlt   // Database field definition (alternative)
	TagDefault  = db.TagDefault // default value
	TagSample   = "sample"      // Sample field value
	TagComment  = "comment"     // Field comment
	TagRequired = "required"    // Is field required
	TagReadonly = "readonly"    // Is field readonly
	TagRole     = "role"        // Field role (see Role* below)
	TagRef      = "ref"         // OpenAPI ref
	TagEnum     = "enum"        // OpenAPI enum content
	TagOA       = "oa"          // OpenAPI name
	TagOAtype   = "oaType"      // OpenAPI type
	TagOAformat = "oaFormat"    // OpenAPI format

	RolePrimary     = "primary"
	RoleKey         = "key"
	StdPrimaryField = VarID

	DefaultValueNull = db.DefaultValueNull
)

Functions

func GetKnownObjects

func GetKnownObjects() map[string]*Object

func SaveObject

func SaveObject(name string, obj reflect.Type, withArray bool, withCU bool) (err error)

func StructType

func StructType(v any) (t reflect.Type, err error)

Types

type Chain

type Chain struct {
	Parent        *Chains         `json:"-"`
	Flags         Flags           `json:"flags,omitempty"`
	Summary       string          `json:"summary"`
	Description   string          `json:"description"`
	Name          string          `json:"name"`
	Scope         string          `json:"scope,omitempty"`
	Params        Params          `json:"params"`
	Tokens        []*Token        `json:"tokens"`
	CacheLifetime config.Duration `json:"cacheLifetime"` // Время жизни кэша, если 0, то не использовать
}

func (*Chain) Clone

func (chain *Chain) Clone() *Chain

type Chains

type Chains struct {
	Summary           string     `json:"summary"`
	Description       string     `json:"description"`
	ParamsDescription string     `json:"paramsDescription"`
	Chains            ChainsList `json:"chains"`
	StdParams         Params     `json:"params"`
	DefaultHttpCode   int        `json:"defaultHttpCode"`
	HttpCodes         []int      `json:"httpCodes"`
	// contains filtered or unexported fields
}

func (*Chains) Clone

func (chains *Chains) Clone() *Chains

func (*Chains) Find

func (chains *Chains) Find(path []string) (matched *Chain, pathParams any, code int, err error)

func (*Chains) Len

func (chains *Chains) Len() int

func (*Chains) Less

func (chains *Chains) Less(i, j int) bool

func (*Chains) Prepare

func (chains *Chains) Prepare(m string) (err error)

func (*Chains) Swap

func (c *Chains) Swap(i, j int)

type ChainsList

type ChainsList []*Chain

func (ChainsList) Clone

func (chainsList ChainsList) Clone() ChainsList

type Flags

type Flags uint64

type Methods

type Methods map[string]*Chains

type Object

type Object struct {
	Type      reflect.Type
	ArrayType reflect.Type
	WithCU    bool
}

type Params

type Params struct {
	Flags Flags `json:"flags,omitempty"`

	InHeaders  misc.StringMap `json:"inHeaders,omitempty"`  // name -> description
	OutHeaders misc.StringMap `json:"outHeaders,omitempty"` // name -> description

	PathParamsPattern any          `json:"pathParams"`
	PathParamsType    reflect.Type `json:"-"`

	QueryParamsPattern any          `json:"queryParams"`
	QueryParamsType    reflect.Type `json:"-"`

	Request  RequestParams  `json:"requestParams"`
	Response ResponseParams `json:"responseParams"`

	DBFields *db.FieldsList `json:"-"`
}

func (*Params) ExtractFieldsFromBody

func (p *Params) ExtractFieldsFromBody(body []byte) (fieldsSlice []misc.InterfaceMap, allMessages [][]string, err error)

func (*Params) MakeTypeFlatModel

func (p *Params) MakeTypeFlatModel() (err error)

func (*Params) Prepare

func (p *Params) Prepare(m string, msgs *misc.Messages) (err error)

type ParamsObject

type ParamsObject struct {
	Name        string       `json:"name"`
	ContentType string       `json:"contentType,omitempty"`
	Pattern     any          `json:"pattern"`
	Type        reflect.Type `json:"-"`
}

type RequestParams

type RequestParams struct {
	ParamsObject    `json:"object"`
	FlatModel       misc.StringMap    `json:"-"`                      // ключ - путь до поля, значение - db name
	BlankTemplate   misc.InterfaceMap `json:"-"`                      // Все поля, которые могут быть изменены, заполненные пустыми значениями, ключ - db name
	RequiredFields  misc.StringMap    `json:"-"`                      // обязательные поля, ключ - путь до поля, значение - db name
	ReadonlyFields  misc.StringMap    `json:"-"`                      // поля только на чтение, ключ - путь до поля, значение - db name
	UniqueKeyFields []string          `json:"requestUniqueKeyFields"` // уникальные поля, первый - primary key (формально)
}

type ResponseParams

type ResponseParams struct {
	ParamsObject `json:"object"`
	SrcPattern   any          `json:"-"`
	SrcType      reflect.Type `json:"-"`
}

type Set

type Set struct {
	Flags       Flags   `json:"flags,omitempty"`
	Summary     string  `json:"summary"`
	Description string  `json:"description"`
	Methods     Methods `json:"methods"`
}

func (*Set) Clone

func (set *Set) Clone() *Set

func (*Set) Find

func (set *Set) Find(m string, path []string) (matched *Chain, pathParams any, result any, code int, err error)

func (*Set) Prepare

func (set *Set) Prepare() (err error)

type Token

type Token struct {
	Description string `json:"description"`
	Expr        string `json:"expr"`
	VarName     string `json:"varName"`
	// contains filtered or unexported fields
}

func (*Token) Clone

func (token *Token) Clone() *Token

type Vars

type Vars misc.InterfaceMap