zeal

Apr 12, 2024

Changes in this version

type ZealMux

+ func StripPrefix(prefix string, h *ZealMux) *ZealMux

+ func (m *ZealMux) Handle(pattern string, handler http.Handler)

Apr 11, 2024

Changes in this version

type HasResponse

+ func (r *HasResponse[T_Response]) Validate(responseWriter *http.ResponseWriter)

type Route

+ func (r *Route) Validate(routeDefinition ...*any) *any

type SpecOptions

+ ZealMux *ZealMux

+ type ZealMux struct

+ Api *rest.API

+ func NewZealMux(mux *http.ServeMux, apiName ...string) *ZealMux

Apr 11, 2024

Changes in this version

+ func NewOpenAPISpec(options SpecOptions) (*openapi3.T, error)

+ func NewRoute[T_Route http.Handler](mux *ServeMux) *T_Route

+ func WriteHeader(w http.ResponseWriter, statusCode int) error

+ type HandlerFuncErr func(http.ResponseWriter, *http.Request) error

+ type HasBody struct

+ Request *http.Request

+ func (b HasBody[T_Body]) Body() T_Body

+ func (b HasBody[T_Body]) Validate() (T_Body, error)

+ type HasParams struct

+ Request *http.Request

+ func (p HasParams[T_Params]) Params() T_Params

+ func (p HasParams[T_Params]) Validate() (T_Params, error)

+ type HasResponse struct

+ ResponseWriter http.ResponseWriter

+ func (r HasResponse[T_Response]) Response(data T_Response, status ...int) error

type Route

+ RouteDefinition *any

+ func (mux *Route) HandleFunc(pattern string, handlerFunc http.HandlerFunc)

+ func (mux *Route) HandleFuncErr(pattern string, handlerFunc HandlerFuncErr)

type SpecOptions

+ ServeMux *ServeMux

Apr 10, 2024

Changes in this version

type RouteMux

+ func (mux *RouteMux[T_Route]) HandleErr(pattern string, handlerFunc HandlerFunc)

+ type RouteParams struct

+ Request *http.Request

+ func (p RouteParams[T_Params]) Params() T_Params

+ func (p RouteParams[T_Params]) Validate() (T_Params, error)

Apr 7, 2024

Changes in this version

+ func CreateOpenAPISpec(options OpenAPISpecOptions) (*openapi3.T, error)

+ func ServeSwaggerUI(mux *ServeMux, spec *openapi3.T, path string) error

+ type OpenAPISpecOptions struct

+ Description string

+ StripPkgPaths []string

+ Version string

+ ZealMux *ServeMux

+ type RouteBody struct

+ Request *http.Request

+ ResponseWriter http.ResponseWriter

+ func (b RouteBody[T_Body]) Body() T_Body

+ func (b RouteBody[T_Body]) Validate() (T_Body, error)

+ type RouteMux struct

+ ResponseWriter *http.ResponseWriter

+ Route T_Route

+ func (mux *RouteMux[T_Route]) Error(status int, message ...string) error

+ func (mux *RouteMux[T_Route]) Handle(pattern string, handlerFunc HandlerFunc)

+ func (mux *RouteMux[T_Route]) HandleFunc(pattern string, handlerFunc http.HandlerFunc)

+ func (mux *RouteMux[T_Route]) Status(status int) error

+ type RoutePath struct

+ Request *http.Request

+ func (p RoutePath[T_Path]) Path() T_Path

+ func (p RoutePath[T_Path]) Validate() (T_Path, error)

+ type RouteQuery struct

+ Request *http.Request

+ func (p RouteQuery[T_Query]) Query() T_Query

+ func (p RouteQuery[T_Query]) Validate() (T_Query, error)

+ type RouteResponse struct

+ ResponseWriter http.ResponseWriter

+ func (r RouteResponse[T_Response]) Response(data T_Response, status ...int) error

Mar 13, 2024

Changes in this version

type ServeMux

+ func (mux *ServeMux) CreateSpec(options SpecOptions) (*openapi3.T, error)

+ type SpecOptions struct

+ Description string

+ StripPkgPaths []string

+ Version string

Mar 13, 2024

Changes in this version

+ type ApiOptions struct

+ Description string

+ StripPkgPaths []string

+ Version string

+ type Response struct

+ Request *http.Request

+ ResponseWriter http.ResponseWriter

+ func (r *Response[T_Response]) JSON(data T_Response, status ...int)

+ func (r Response[T_Response]) Error(status int, errorMsg ...string)

+ func (r Response[T_Response]) Status(status int)

+ type ServeMux struct

+ Api *rest.API

+ func NewServeMux(apiName ...string) *ServeMux

+ func (mux *ServeMux) CreateAPI(options ApiOptions) (*openapi3.T, error)

+ func (mux *ServeMux) ListenAndServe(options ServeOptions) error

+ func (mux *ServeMux) ServeSwaggerUI(spec *openapi3.T, path string) error

+ type ServeOptions struct

+ Port int

+ ServeSwaggerUI bool

+ Spec *openapi3.T

+ SwaggerPattern string

+ type URLPathParamPlaceholder struct

Mar 11, 2024

Changes in this version

+ func Handle[T_Response, T_Params, T_Body any](router *Router, pattern string, handler Handler[T_Response, T_Params, T_Body])

type Ctx

+ func (c *Ctx[T_Response]) JSON(data T_Response, status ...int)

+ func (c Ctx[T_Response]) Error(status int, errorMsg ...string)

+ type Handler func(Ctx[T_Response], T_Params, T_Body)

Mar 10, 2024

Changes in this version

type Ctx

+ Params T_Params

+ Request *http.Request

+ ResponseWriter http.ResponseWriter

+ func (c Ctx[T_Params]) Status(status int)

Mar 10, 2024

Changes in this version

+ func Error[T_Response any](c ctx, status int) T_Response

+ func Ping[T_Params any](router *Router, pattern string, handler pingHandler[T_Params])

+ func Pull[T_Params, T_Response any](router *Router, pattern string, handler pullHandler[T_Params, T_Response])

+ func Push[T_Params, T_Body any](router *Router, pattern string, handler pushHandler[T_Params, T_Body])

+ func Trade[T_Params, T_Body, T_Response any](router *Router, pattern string, ...)

+ type Ctx struct

+ Param T_Params

+ R *http.Request

+ W http.ResponseWriter

+ func (c Ctx[T_Params]) GetWriter() http.ResponseWriter

Mar 10, 2024

Changes in this version

+ func BodyRoute[T_Response, T_Params, T_Body any](router *Router, pattern string, ...)

+ func Route[T_Response, T_Params any](router *Router, pattern string, handler HandlerFunc[T_Response, T_Params])

+ type BodyHandlerFunc func(ResponseWriter[T_Response], *Request[T_Params], T_Body)

+ type HandlerFunc func(ResponseWriter[T_Response], *Request[T_Params])

Mar 9, 2024

Changes in this version

+ func Read[ResponseType, ParamsType any](router *Router, pattern string, handler ReadHandler[ResponseType, ParamsType])

+ func Write[ResponseType, ParamsType, BodyType any](router *Router, pattern string, ...)

+ type ReadHandler func(ResponseWriter[ResponseType], *Request[ParamsType])

+ type Request struct

+ Params ParamsType

+ type ResponseWriter struct

+ func (w *ResponseWriter[ResponseType]) JSON(data ResponseType, status ...int)

+ type WriteHandler func(ResponseWriter[ResponseType], *Request[ParamsType], BodyType)

Sep 8, 2023

Changes in this version

+ func Delete(router *Router, pattern string, ...)

+ func Get(router *Router, pattern string, ...)

+ func Post(router *Router, pattern string, ...)

+ func Put(router *Router, pattern string, ...)

+ type HandlerFuncRead func(Writer[ResponseType], *Rqr[ParamsType])

+ type HandlerFuncWrite func(Writer[ResponseType], *Rqw[ParamsType, BodyType])

+ type QueryParam struct

+ type RouteSchema struct

+ type Router struct

+ Api *rest.API

+ func NewRouter(name string) *Router

+ func (r *Router) CreateSpec(version string, description string) *openapi3.T

+ func (r *Router) ServeSwaggerUI(spec *openapi3.T, path string)

+ type Rqr struct

+ Params ParamsType

+ Request *http.Request

+ type Rqw struct

+ Body BodyType

+ type Writer struct

+ func (w *Writer[ResponseType]) JSON(status int, data ResponseType)