Documentation
¶
Index ¶
- Constants
- func Default() ctx.ServicePackage
- type AuthenticationResultCode
- type Middleware
- type RequestData
- type RequestHandler
- type Response
- func (h *Response) BadRequest() *Response
- func (h *Response) BadRequestReason(reason ...string) *Response
- func (h *Response) Content(content any) *Response
- func (h *Response) Error(err error) *Response
- func (h *Response) NotFound() *Response
- func (h *Response) Ok() *Response
- func (h *Response) Status(status int) *Response
- func (h *Response) VerifyNotEmpty(strs ...string) bool
- type RestServer
- type TypedRequestHandler
Constants ¶
View Source
const ( AuthenticationRequired = AuthenticationResultCode(1) Forbidden = AuthenticationResultCode(2) Authorized = AuthenticationResultCode(3) )
Variables ¶
This section is empty.
Functions ¶
func Default ¶
func Default() ctx.ServicePackage
Types ¶
type AuthenticationResultCode ¶
type AuthenticationResultCode int
type Middleware ¶ added in v0.3.0
type Middleware func(chain rest.HandlerFunc, writer rest.ResponseWriter, request *rest.Request) error
func BasicAuthenticator ¶ added in v0.3.0
func BasicAuthenticator(authFn func(path string, username string, password string) AuthenticationResultCode) Middleware
func BearerTokenAuthenticator ¶
func BearerTokenAuthenticator(authFn func(path string, token string) AuthenticationResultCode) Middleware
type RequestData ¶
func (*RequestData) Credential ¶
func (d *RequestData) Credential() int64
func (*RequestData) Path ¶
func (d *RequestData) Path() map[string]string
func (*RequestData) Query ¶
func (d *RequestData) Query() url.Values
type RequestHandler ¶
type RequestHandler interface {
Path(path string) RequestHandler
Method(method string) RequestHandler
Middleware(middleware Middleware) RequestHandler
Handler(handler func(request *RequestData) (rs Response))
HandlerRaw(handler func(request *RequestData, responseWriter rest.ResponseWriter) error)
}
func BuildRoute ¶ added in v0.2.0
func BuildRoute(server RestServer) RequestHandler
func RegisterRoute ¶ added in v0.2.0
func RegisterRoute(server RestServer, method string, path string) RequestHandler
type Response ¶ added in v0.2.0
type Response struct {
// contains filtered or unexported fields
}
func (*Response) BadRequest ¶ added in v0.2.0
func (*Response) BadRequestReason ¶ added in v0.2.0
func (*Response) VerifyNotEmpty ¶ added in v0.2.0
type RestServer ¶
type RestServer interface {
AddMiddleware(middleware Middleware) RestServer
// contains filtered or unexported methods
}
func NewRestServer ¶
func NewRestServer(name string, configPrefix string) RestServer
type TypedRequestHandler ¶ added in v0.2.0
type TypedRequestHandler[T any] interface { Path(path string) TypedRequestHandler[T] Method(method string) TypedRequestHandler[T] Middleware(middleware Middleware) TypedRequestHandler[T] Handler(handler func(request *RequestData, body T) (rs Response)) }
func BuildTypedRoute ¶ added in v0.2.0
func BuildTypedRoute[T any](server RestServer) TypedRequestHandler[T]
func RegisterTypedRoute ¶ added in v0.2.0
func RegisterTypedRoute[T any](server RestServer, method string, path string) TypedRequestHandler[T]
Source Files
Click to show internal directories.
Click to hide internal directories.