Class lugate.request
The lugate module.
Lugate is a lua module for building JSON-RPC 2.0 Gateway APIs just inside of your Nginx configuration file. Lugate is meant to be used with [ngx\_http\_lua\_module](https://github.com/openresty/lua-nginx-module) together.
Info:
- License: MIT
- Author: Ivan Zinovyev
Functions
| Request:new (data, lugate) | Create new request param[type=table] data Request data param[type=table] lugate Lugate instance return[type=table] New request instance |
| Request:is_valid () | Check if request is valid JSON-RPC 2.0 |
| Request:is_proxy_call (data) | Check if request is a valid Lugate proxy call over JSON-RPC 2.0 |
| Request:get_jsonrpc () | Get JSON-RPC version |
| Request:get_method () | Get method name |
| Request:get_params () | Get request params (search for nested params) |
| Request:get_id () | Get request id |
| Request:get_route () | Get request route |
| Request:get_ttl () | Get request cache key |
| Request:get_key () | Get request cache key |
| Request:get_tags () | Get request cache tags |
| Request:is_cachable () | Check if request is cachable |
| Request:get_uri () | Get uri passing for request data |
| Request:get_data () | Get request data table |
| Request:get_body () | Get request body |
| Request:get_ngx_request (data) | Build a request in format acceptable by nginx |
Functions
Methods- Request:new (data, lugate)
-
Create new request
param[type=table] data Request data
param[type=table] lugate Lugate instance
return[type=table] New request instance
Parameters:
- data
- lugate
- Request:is_valid ()
-
Check if request is valid JSON-RPC 2.0
Returns:
-
boolean
- Request:is_proxy_call (data)
-
Check if request is a valid Lugate proxy call over JSON-RPC 2.0
Parameters:
- data table Decoded request body
Returns:
-
boolean
- Request:get_jsonrpc ()
-
Get JSON-RPC version
Returns:
- Request:get_method ()
-
Get method name
Returns:
- Request:get_params ()
-
Get request params (search for nested params)
Returns:
- Request:get_id ()
-
Get request id
Returns:
-
int
- Request:get_route ()
-
Get request route
Returns:
- Request:get_ttl ()
-
Get request cache key
Returns:
- Request:get_key ()
-
Get request cache key
Returns:
- Request:get_tags ()
-
Get request cache tags
Returns:
- Request:is_cachable ()
-
Check if request is cachable
Returns:
-
boolean
- Request:get_uri ()
-
Get uri passing for request data
Returns:
- Request:get_data ()
-
Get request data table
Returns:
- Request:get_body ()
-
Get request body
Returns:
-
string
Json array
- Request:get_ngx_request (data)
-
Build a request in format acceptable by nginx
Parameters:
- data table Decoded requets body
Returns: