utils

Documentation

Index

• func ClientIP(r *http.Request) string
• func ExtractPagingParams(req *restful.Request, minPageSize, maxPageSize int) (int, int, error)
• func FirstLower(s string) string
• func FirstUpper(s string) string
• func GenerateVersion(pre string) string
• func GetDefaultUIType(apiType string, haveOptions bool, subType string, haveSub bool) string
• func RenderLabel(source interface{}) string
• func StringsContain(items []string, source string) bool
• type GroupOption
• type MemoryCache
  • func NewMemoryCache(data interface{}, cacheDuration time.Duration) *MemoryCache
  • func (m *MemoryCache) GetData() interface{}
  • func (m *MemoryCache) IsExpired() bool
• type Option
• type ResponseCapture
  • func NewResponseCapture(w http.ResponseWriter) *ResponseCapture
  • func (c ResponseCapture) Bytes() []byte
  • func (c ResponseCapture) Header() http.Header
  • func (c ResponseCapture) StatusCode() int
  • func (c ResponseCapture) Write(data []byte) (int, error)
  • func (c *ResponseCapture) WriteHeader(statusCode int)
• type UIParameter
  • func ParseUIParameterFromDefinition(definition []byte) ([]*UIParameter, error)
• type Validate

Functions

func ClientIP

func ClientIP(r *http.Request) string

ClientIP get client ip

func ExtractPagingParams

func ExtractPagingParams(req *restful.Request, minPageSize, maxPageSize int) (int, int, error)

ExtractPagingParams extract `page` and `pageSize` params from request

func FirstLower

func FirstLower(s string) string

FirstLower Sets the first letter of the string to lowercase.

func FirstUpper

func FirstUpper(s string) string

FirstUpper Sets the first letter of the string to upper.

func GenerateVersion

func GenerateVersion(pre string) string

GenerateVersion Generate version numbers by time

func GetDefaultUIType

func GetDefaultUIType(apiType string, haveOptions bool, subType string, haveSub bool) string

GetDefaultUIType Set the default mapping for API Schema Type

func RenderLabel

func RenderLabel(source interface{}) string

RenderLabel render option label

func StringsContain

func StringsContain(items []string, source string) bool

StringsContain strings contain

Types

type GroupOption

type GroupOption struct {
	Label string   `json:"label"`
	Keys  []string `json:"keys"`
}

GroupOption define multiple data structure composition options.

type MemoryCache

type MemoryCache struct {
	// contains filtered or unexported fields
}

MemoryCache memory cache, support time expired

func NewMemoryCache

func NewMemoryCache(data interface{}, cacheDuration time.Duration) *MemoryCache

NewMemoryCache new memory cache instance

func (*MemoryCache) GetData

func (m *MemoryCache) GetData() interface{}

GetData get cache data

func (*MemoryCache) IsExpired

func (m *MemoryCache) IsExpired() bool

IsExpired whether the cache data expires

type Option

type Option struct {
	Label string      `json:"label"`
	Value interface{} `json:"value"`
}

Option select option

type ResponseCapture

type ResponseCapture struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

ResponseCapture capture response and get response info

func NewResponseCapture

func NewResponseCapture(w http.ResponseWriter) *ResponseCapture

NewResponseCapture new response capture

func (ResponseCapture) Bytes

func (c ResponseCapture) Bytes() []byte

Bytes return response body bytes

func (ResponseCapture) Header

func (c ResponseCapture) Header() http.Header

Header return response writer header

func (ResponseCapture) StatusCode

func (c ResponseCapture) StatusCode() int

StatusCode return status code

func (ResponseCapture) Write

func (c ResponseCapture) Write(data []byte) (int, error)

Write write data to response writer and body

func (*ResponseCapture) WriteHeader

func (c *ResponseCapture) WriteHeader(statusCode int)

WriteHeader write header to response writer

type UIParameter

type UIParameter struct {
	Sort        uint      `json:"sort"`
	Label       string    `json:"label"`
	Description string    `json:"description"`
	Validate    *Validate `json:"validate,omitempty"`
	JSONKey     string    `json:"jsonKey"`
	UIType      string    `json:"uiType"`
	// means disable parameter in ui
	Disable                 *bool          `json:"disable,omitempty"`
	SubParameterGroupOption []GroupOption  `json:"subParameterGroupOption,omitempty"`
	SubParameters           []*UIParameter `json:"subParameters,omitempty"`
	AdditionalParameter     *UIParameter   `json:"additionalParameter,omitempty"`
	Additional              *bool          `json:"additional,omitempty"`
}

UIParameter Structured import table simple UI model

func ParseUIParameterFromDefinition

func ParseUIParameterFromDefinition(definition []byte) ([]*UIParameter, error)

ParseUIParameterFromDefinition cue of parameter in Definitions was analyzed to obtain the form description model.

type Validate

type Validate struct {
	Required     bool        `json:"required,omitempty"`
	Max          *float64    `json:"max,omitempty"`
	MaxLength    *uint64     `json:"maxLength,omitempty"`
	Min          *float64    `json:"min,omitempty"`
	MinLength    uint64      `json:"minLength,omitempty"`
	Pattern      string      `json:"pattern,omitempty"`
	Options      []Option    `json:"options,omitempty"`
	DefaultValue interface{} `json:"defaultValue,omitempty"`
}

Validate parameter validate rule