Categorygithub.com/jgolang/apirest
modulepackage
1.0.1
Repository: https://github.com/jgolang/apirest.git
Documentation: pkg.go.dev

# Functions

BasicAuth ...
Check doc...
GetHeaderValueInt doc ...
GetHeaderValueInt64 doc ...
GetHeaderValueString doc ...
GetQueryParamValueInt ...
GetQueryParamValueInt64 ...
GetQueryParamValueString ...
GetRouteVarValueInt ...
GetRouteVarValueInt64 ...
GetRouteVarValueString ...
MiddlewaresChain provides syntactic sugar to create a new middleware which will be the result of chaining the ones received as parameters.
RequestBody doc ...
RequestHeaderJSON validate header Content-Type, is required and equal to application/json.
RequestHeaderSession doc ...
SendResponse ...
UnmarshalBody doc ...

# Variables

DefaultErrorMessage doc ..
DefaultErrorTitle doc ...
DefaultInfoMessage doc ..
DefaultInfoTitle doc ...
DefaultSuccessMessage doc ..
DefaultSuccessTitle doc ...
DefaultWarningMessage doc ..
DefaultWarningTitle doc ...
ErrorType error response type the value is "error".
InformativeType info response type the value is "info".
Password doc ...
SessionIDPayload doc ...
SuccessType success response type the value is "success".
TraceIDPayload doc ..
UserIDPayload doc ...
Username doc ...
WarningType warning response type the value is "warning".

# Structs

Error error response type the value is "error".
Informative info response type the value is "info".
JSONRequest struct used to parse the request content section.
JSONRequestInfo request info section fields for encrypted requests.
JSONResponse response body structure contains the info section, with the response type and the messages for users and the content section, with the required data for the request.
JSONResponseInfo response body info section.
RequestBasic doc ...
ResponseData ...
Success success response type the value is "success".
Warning warning response type the value is "warning".

# Interfaces

Response ...

# Type aliases

Middleware provides a convenient mechanism for filtering HTTP requests entering the application.
ResponseType contains all the response types identiers.