# README
rest package
This package includes definitions and implementation of a web server with the following capabilities:
- REST server
- Web Socket server
- REST utilities
- Static files server
# Functions
No description provided by the author
GetBoolParamValue extracts parameter value from query string as bool.
GetEnumParamArray extracts parameter array values from query string as enums to support multiple values query string e.g.
GetEnumParamValue extracts parameter value from query string as enum Enum value can be passed as it's int or string value.
GetFloatParamValue extract parameter value from query string as float64.
GetInt64ParamValue extract parameter value from query string as long.
GetIntParamArray extract parameter array values from query string to support multiple values query string e.g.
GetIntParamValue extract parameter value from query string as int.
GetIntParamValueFromPath extracts parameter value from path params as int.
GetStringParamArray extracts parameter array values from query string to support multiple values query string e.g.
GetStringParamValue extract parameter value from query string as string.
GetStringParamValueFromPath extracts parameter value from path params as string.
GetUInt64ParamArray extract parameter array values from query string This supports multiple values query string e.g.
GetUint64ParamValue extract parameter value from query string as unsigned-long.
NewActionResponse factory method.
NewActionResponseError with error.
NewEntitiesResponse factory method.
NewEntitiesResponseError with error.
NewEntityResponse factory method.
NewEntityResponseError with error.
NewRequestWithToken is the factory method of RequestWithToken.
No description provided by the author
No description provided by the author
ResolveRemoteIpFromHttpRequest extracts remote ip from HTTP header X-Forwarded-For.
# Structs
ActionResponse message is returned for any action on entity with no return data (e.d.
BaseRestResponse is a common structure for all response types.
EntitiesResponse message is returned for any action returning multiple entities.
EntityResponse message is returned for any create/update action on entity.
RequestWithToken includes access to the JWT token.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
IRestResponse is an interface that all rest response messages must comply.
No description provided by the author
# Type aliases
No description provided by the author
RestHandler function signature.
RestHandlerAdaptorFunc function signature.