common

README

common

Documentation

Index

• Variables
• type APIContext
• type ContextKey
• type DalContext
• type GlobalThisReader
• type Handler
• type HandlerFunc
  • func (hf HandlerFunc) Process(ctx APIContext) error
• type PreparedQuery
• type QueryResult
• type RequestContext
• type RequestReader
• type RequestWriter
• type ResponseReader
• type ResponseWriter
• type ScriptRunner

Variables

var ApiCtxKey = ContextKey{}

Types

type APIContext

type APIContext interface {
	RequestReader
	ResponseReader
	RequestWriter
	ResponseWriter
}

APIContext combines request and response contexts

type ContextKey

type ContextKey struct{}

type DalContext

type DalContext struct {
	DefaultEntity string
	Container     *sync.Map

	TraceID  string
	ParentID string
	SpanID   string
}

type GlobalThisReader

type GlobalThisReader interface {
	Input() any
	Env() map[string]any
	Metas() map[string]any
	Session() map[string]any
	RequestHeaders() map[string]any

	Output() any
	ResponseHeaders() map[string]any
}

type Handler

type Handler interface {
	Process(APIContext) error
}

type HandlerFunc

type HandlerFunc func(APIContext) error

func (HandlerFunc) Process

func (hf HandlerFunc) Process(ctx APIContext) error

type PreparedQuery

type PreparedQuery struct {
	Query     string `json:"query"`
	Bind      []any  `json:"bind"`
	QueryType string `json:"queryType"`

	CheckPoint      []*PreparedQuery `json:"checkPoint"`
	DatabaseUpdater []*PreparedQuery `json:"databaseUpdater"`
	ResultEnricher  []*PreparedQuery `json:"resultEnricher"`
}

type QueryResult

type QueryResult struct {
	QueryType    string
	LastInsertId int64
	RowsAffected int64
	Row          map[string]any
	Rows         []map[string]any
	Total        int64
}

type RequestContext

type RequestContext struct {
	ApiName     string
	RemoteAddr  string
	RemoteHost  string
	RequestTime time.Time
}

type RequestReader

type RequestReader interface {
	RequestID() string
	RequestContext() *RequestContext
	Method() string
	Params() any
	RawParams() []byte
	Metas() map[string]any
}

RequestReader contains request-related information

type RequestWriter

type RequestWriter interface {
	SetRequestID(string)
	SetMethod(string)
	SetParams(any)
	SetRawParams([]byte)
	SetMetas(map[string]any)
}

RequestWriter allows modification of request-related information

type ResponseReader

type ResponseReader interface {
	Result() any
	Err() error
}

ResponseReader contains response-related information

type ResponseWriter

type ResponseWriter interface {
	SetResult(any)
	SetErr(error)
}

ResponseWriter allows modification of response-related information

type ScriptRunner

type ScriptRunner interface {
	RunScript(globalThis map[string]any, dalCtx *DalContext, sourceCode string) (any, error)
}