webapi

Feb 4, 2024

Changes in this version

type ApiHandlerWrapper

+ func Wrap(h ApiHandler) *ApiHandlerWrapper

Sep 7, 2023

Changes in this version

+ const HttpHeaderContentDisposition

Aug 18, 2023

Changes in this version

+ type RouteParam struct

+ Key string

+ Value string

+ func AllRouteParams(r *http.Request) []RouteParam

Oct 20, 2022

Changes in this version

type ArgumentDecodeFunc

+ func (f ArgumentDecodeFunc) DecodeArg(state *ApiState, index int, argType reflect.Type) (ok bool, v any, err error)

type LogSetupFunc

+ func (f LogSetupFunc) Setup(state *ApiState)

Sep 27, 2022

Changes in this version

type ApiEngine

+ func (engine *ApiEngine) HandleConnect(path string, handlerFunc http.HandlerFunc)

+ func (engine *ApiEngine) HandleDelete(path string, handlerFunc http.HandlerFunc)

+ func (engine *ApiEngine) HandleGet(path string, handlerFunc http.HandlerFunc)

+ func (engine *ApiEngine) HandleHead(path string, handlerFunc http.HandlerFunc)

+ func (engine *ApiEngine) HandleOptions(path string, handlerFunc http.HandlerFunc)

+ func (engine *ApiEngine) HandlePatch(path string, handlerFunc http.HandlerFunc)

+ func (engine *ApiEngine) HandlePost(path string, handlerFunc http.HandlerFunc)

+ func (engine *ApiEngine) HandlePut(path string, handlerFunc http.HandlerFunc)

+ func (engine *ApiEngine) HandleTrace(path string, handlerFunc http.HandlerFunc)

Sep 21, 2022

Changes in this version

+ type ApiDecoderFunc func(state *ApiState)

+ func (f ApiDecoderFunc) Decode(state *ApiState)

+ type ApiLoggerFunc func(state *ApiState)

+ func (f ApiLoggerFunc) Log(state *ApiState)

+ type ApiMethodCallerFunc func(state *ApiState)

+ func (f ApiMethodCallerFunc) Call(state *ApiState)

+ type ApiNameResolverFunc func(state *ApiState)

+ func (f ApiNameResolverFunc) FillMethod(state *ApiState)

+ type ApiResponseBuilderFunc func(state *ApiState)

+ func (f ApiResponseBuilderFunc) BuildResponse(state *ApiState)

+ type ApiResponseWriterFunc func(state *ApiState)

+ func (f ApiResponseWriterFunc) WriteResponse(state *ApiState)

+ type ApiUserHostResolverFunc func(state *ApiState)

+ func (f ApiUserHostResolverFunc) FillUserHost(state *ApiState)

Aug 11, 2022

Changes in this version

+ var ApiStateArgumentDecoder = ToArgumentDecoder(...)

+ type ArgumentDecodeFunc func(state *ApiState, index int, argType reflect.Type) (ok bool, v interface{}, err error)

+ type ArgumentDecoder interface

+ DecodeArg func(state *ApiState, index int, argType reflect.Type) (ok bool, v interface{}, err error)

+ func ToArgumentDecoder(f ArgumentDecodeFunc) ArgumentDecoder

+ type ArgumentDecoderPipeline []ArgumentDecoder

+ func NewArgumentDecoderPipeline(d ...ArgumentDecoder) ArgumentDecoderPipeline

+ func (d ArgumentDecoderPipeline) Decode(state *ApiState)

+ type LogSetup interface

+ Setup func(state *ApiState)

+ func ToLogSetup(f LogSetupFunc) LogSetup

+ type LogSetupFunc func(state *ApiState)

+ type LogSetupPipeline []LogSetup

+ func NewLogSetupPipeline(s ...LogSetup) LogSetupPipeline

+ func (p LogSetupPipeline) Log(state *ApiState)

Aug 6, 2022

Changes in this version

+ func ApiStateDecodeFunc(state *ApiState, index int, argType reflect.Type) (ok bool, v interface{}, err error)

type ApiResponse

+ func BadRequestResponse() *ApiResponse[any]

+ func InternalErrorResponse() *ApiResponse[any]

type ApiState

+ LogLevel logx.Level

+ LogMessage []any

+ type DecodeFunc func(state *ApiState, index int, argType reflect.Type) (ok bool, v interface{}, err error)

+ type DecodeFuncPipeline []DecodeFunc

+ func NewDecodeFuncPipeline(decodeFuncs ...DecodeFunc) DecodeFuncPipeline

+ func (d DecodeFuncPipeline) Decode(state *ApiState)

+ type LogFunc func(state *ApiState)

+ type LogFuncPipeline []LogFunc

+ func NewLogFuncPipeline(fs ...LogFunc) LogFuncPipeline

+ func (p LogFuncPipeline) Log(state *ApiState)

Apr 11, 2022

Changes in this version

type ApiDecoder

+ func NewUniqueTypeApiMethodDecoder(decodeFuncs ...ApiMethodArgDecodeFunc) ApiDecoder

+ type ApiMethodArgDecodeFunc func(state *ApiState, index int, argType reflect.Type) (ok bool, v interface{}, err error)

Mar 6, 2022

Changes in this version

+ const ContentTypeBinary

+ const ContentTypeForm

+ const ContentTypeJavascript

+ const ContentTypeJson

+ const ContentTypeMultipartForm

+ const ContentTypeNone

+ const ContentTypePlainText

+ const ErrorCodeBadRequest

+ const ErrorCodeInternalError

+ const HttpHeaderContentType

+ func CreateHandlerFunc(handler ApiHandler, logFinder logx.LogFinder) http.HandlerFunc

+ func DescribeError(err error) (logLevel logx.Level, errTypeName, errDescription string)

+ func GetRouteParam(r *http.Request, name string) string

+ func PanicApiError(state *ApiState, cause error, message string, args ...interface{})

+ func SetRouteParams(r *http.Request, params map[string]string) *http.Request

+ type ApiDecoder interface

+ Decode func(state *ApiState)

+ type ApiEngine struct

+ func NewEngine() *ApiEngine

+ func (engine *ApiEngine) Handle(path string, handler ApiHandler, logFinder logx.LogFinder) ApiSetup

+ func (engine *ApiEngine) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type ApiError struct

+ func CreateApiError(state *ApiState, cause error, message string, args ...interface{}) ApiError

+ func (e ApiError) Error() string

+ type ApiHandler interface

+ Name func() string

+ SupportedHttpMethods func() []string

+ type ApiHandlerWrapper struct

+ HandlerName string

+ HttpMethods []string

+ func (w *ApiHandlerWrapper) Name() string

+ func (w *ApiHandlerWrapper) SupportedHttpMethods() []string

+ type ApiLogger interface

+ Log func(state *ApiState)

+ type ApiMethod struct

+ Name string

+ Provider string

+ Value reflect.Value

+ type ApiMethodCaller interface

+ Call func(state *ApiState)

+ func NewBasicApiMethodCaller() ApiMethodCaller

+ type ApiMethodRegister interface

+ GetMethod func(name string) (method ApiMethod, ok bool)

+ RegisterMethod func(m ApiMethod)

+ RegisterMethods func(providerStruct interface{})

+ func NewBasicApiMethodRegister() ApiMethodRegister

+ type ApiNameResolver interface

+ FillMethod func(state *ApiState)

+ type ApiResponse struct

+ Code int

+ Data interface{}

+ Message string

+ func SuccessResponse(data interface{}) *ApiResponse

+ type ApiResponseBuilder interface

+ BuildResponse func(state *ApiState)

+ func NewBasicApiResponseBuilder() ApiResponseBuilder

+ type ApiResponseWriter interface

+ WriteResponse func(state *ApiState)

+ type ApiSetup struct

+ func (setup ApiSetup) RegisterMethods(providerStruct interface{}) ApiSetup

+ type ApiState struct

+ Args []reflect.Value

+ Data interface{}

+ Error error

+ Handler ApiHandler

+ Logger logx.Logger

+ Method ApiMethod

+ Name string

+ Query QueryString

+ RawRequest *http.Request

+ RawResponse http.ResponseWriter

+ Response *ApiResponse

+ ResponseBody io.Reader

+ ResponseContentType string

+ UserHost string

+ func NewState(r http.ResponseWriter, w *http.Request, handler ApiHandler) *ApiState

+ func (s *ApiState) GetCustomData(key string) (interface{}, bool)

+ func (s *ApiState) MustHaveMethod()

+ func (s *ApiState) MustHaveName()

+ func (s *ApiState) MustHaveResponse()

+ func (s *ApiState) SetCustomData(key string, value interface{})

+ type ApiUserHostResolver interface

+ FillUserHost func(state *ApiState)

+ func NewBasicApiUserHostResolver() ApiUserHostResolver

+ type BadRequestError struct

+ func CreateBadRequestError(state *ApiState, cause error, message string, args ...interface{}) BadRequestError

+ func (e BadRequestError) Error() string

+ type QueryString struct

+ HasNameless bool

+ Named map[string]string

+ Nameless string

+ func ParseQueryString(queryString string) QueryString

+ func (qs QueryString) Get(name string) (string, bool)