Module lugate
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
Lugate:new (config) | Create new Lugate instance |
Lugate:configure (config) | Configure lugate instance |
Lugate:get_data () | Parse raw body |
Lugate:get_requests () | Get request collection |
Lugate:create_request (data) | Create new request object |
Lugate:is_batch (data) | Check if request is a batch |
Lugate:is_valid (data) | Check if single request is valid |
Lugate:is_proxy_call (data) | Is a valid proxy call over JSON-RPC 2.0 |
Lugate:get_route (data) | Get route for request data |
Lugate:normalize_params (data) | Normalize data params |
Lugate:ngx_request (data) | Build a request in format acceptable by nginx |
Lugate:ngx_requests (data) | Build all requests in format acceptable by nginx |
Functions
Methods- Lugate:new (config)
-
Create new Lugate instance
Parameters:
- config table Table of configuration options: body for raw request body and routes for routing map config
Returns:
-
Lugate
The new instance of Lugate
- Lugate:configure (config)
-
Configure lugate instance
Parameters:
- config table Table of configuration options
- Lugate:get_data ()
-
Parse raw body
Returns:
- Lugate:get_requests ()
-
Get request collection
Returns:
-
table
The table of requests
- Lugate:create_request (data)
-
Create new request object
Parameters:
- data
Returns:
-
table
The request object
- Lugate:is_batch (data)
-
Check if request is a batch
Parameters:
- data table Decoded request body
Returns:
-
boolean
- Lugate:is_valid (data)
-
Check if single request is valid
Parameters:
- data table Decoded request body
Returns:
-
boolean
- Lugate:is_proxy_call (data)
-
Is a valid proxy call over JSON-RPC 2.0
Parameters:
- data table Decoded request body
Returns:
-
boolean
- Lugate:get_route (data)
-
Get route for request data
Parameters:
- data table Decoded requets body
Returns:
-
string
- Lugate:normalize_params (data)
-
Normalize data params
Parameters:
- data
- Lugate:ngx_request (data)
-
Build a request in format acceptable by nginx
Parameters:
- data table Decoded requets body
Returns:
-
table
- Lugate:ngx_requests (data)
-
Build all requests in format acceptable by nginx
Parameters:
- data table Decoded requets body
Returns:
-
table