api

Aug 17, 2023

Changes in this version

type Response

+ MetaData database.ResponseMetaData

Aug 17, 2023

Changes in this version

type Request

+ GetFile func(key string) (multipart.File, *multipart.FileHeader, error)

Mar 26, 2023

Changes in this version

+ func ArrContains(arr []T, val T) bool

+ func GenerateQueryComponenFromStruct(model interface{}, skips []string) (string, []interface{}, string)

+ func GetStructKey(field reflect.StructField) string

+ func GetStructValue(value reflect.Value) interface

+ func InitHandler(router http.Handler) http.Handler

+ func MethodNotAllowedHandler(w http.ResponseWriter, r *http.Request)

+ func PanicHandler(next http.Handler) http.Handler

+ func RouteNotFoundHandler(w http.ResponseWriter, r *http.Request)

+ func WriteJson(w http.ResponseWriter, data interface{})

+ type App struct

+ Http *chi.Mux

+ TotalEndpoints int

+ func NewApp(opts ...Options) *App

+ func (app *App) AddController(ctrl Controller)

+ func (app *App) Init()

+ func (app *App) Start() error

+ type AppImplementor struct

+ type Apps interface

+ LoadModules func()

+ type Controller interface

+ GetConfig func() ControllerConfig

+ type ControllerConfig struct

+ Middlewares *[]func(http.Handler) http.Handler

+ Path string

+ Routes []Route

+ type ControllerImpl struct

+ func (ctrl *ControllerImpl) JoinMiddleware(handlers ...func(http.Handler) http.Handler) *[]func(http.Handler) http.Handler

+ type ErrorOption func(*HttpError)

+ func WithCode(code string) ErrorOption

+ func WithData(data interface{}) ErrorOption

+ func WithMessage(message string) ErrorOption

+ func WithStatus(status int) ErrorOption

+ type Handler func(Request, context.Context) *Response

+ type HttpError struct

+ Code string

+ Data *interface{}

+ Message string

+ Status int

+ func BadRequest(message, code string) *HttpError

+ func Forbidden(message, code string) *HttpError

+ func InternalServerError(message, code string) *HttpError

+ func MethodNotAllowed(message, code string) *HttpError

+ func NewErr(opts ...ErrorOption) *HttpError

+ func NotFound(message, code string) *HttpError

+ func TooManyRequest(message, code string) *HttpError

+ func Unauthorized(message, code string) *HttpError

+ func UnprocessableEntity(message, code string) *HttpError

+ func (e *HttpError) Error() string

+ func (err *HttpError) Write(w http.ResponseWriter)

+ type Map map[string]interface

+ type Options func(api *App)

+ func ReadTimeout(readTimeout int) Options

+ func WithAPITimeout(apiTimeout int) Options

+ func WithAppPort(port int) Options

+ func WriteTimeout(writeTimeout int) Options

+ type Request struct

+ GetBody func(interface{}) error

+ GetHeaders func(interface{}) error

+ GetParams func(key string, defaultValue ...string) string

+ GetQuery func(interface{}) error

+ type Response struct

+ Data interface{}

+ Err error

+ Message string

+ func NewResponse() *Response

+ func (resp *Response) SetData(data interface{}) *Response

+ func (resp *Response) SetError(err error) *Response

+ func (resp *Response) SetHTTPError(err *HttpError) *Response

+ func (resp *Response) SetMessage(msg string) *Response

+ type Route struct

+ Handler Handler

+ Method string

+ Middlewares *[]func(http.Handler) http.Handler

+ Path string

+ Version int

+ func NewRoute(method string, handler Handler, opts ...RouteOption) Route

+ func (r *Route) GetVersionedPath(controllerPath string) string

+ type RouteOption func(*Route)

+ func WithMiddleware(handlers ...func(http.Handler) http.Handler) RouteOption

+ func WithPath(path string) RouteOption

+ func WithVersion(version int) RouteOption

+ type StringMap map[string]string

+ type ValidationError struct

+ Field string

+ Tag string

+ Value string

+ func ValidateStruct(data interface{}) []*ValidationError

+ type WrittenResponseWriter struct

+ func (w *WrittenResponseWriter) Write(b []byte) (int, error)

+ func (w *WrittenResponseWriter) WriteHeader(status int)

+ func (w *WrittenResponseWriter) Written() bool