Class 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:load_module (definition, alternatives) | Load module from the list of alternatives |
| Lugate:init (config) | Create new Lugate instance. |
| Lugate:write_log (message, comment) | Format error message |
| Lugate:build_json_error (code, message, data, id) | Get a proper formated json error |
| Lugate:is_not_empty () | Check if request is empty |
| Lugate:get_body () | Get ngx request body |
| Lugate:get_data () | Parse raw body |
| Lugate:is_batch (data) | Check if request is a batch |
| Lugate:get_requests () | Get request collection |
| Lugate:run () | Get request collection prepared for ngx.location.capture_multi call |
| Lugate:attach_request (i, request, ngx_requests) | Attach request to the pipeline |
| Lugate:handle_response (n, response) | Handle every single response |
| Lugate:clean_response (response) | Clean response (trim) |
| Lugate:print_responses () | Print all responses and exit |
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:
-
table
The new instance of Lugate
- Lugate:load_module (definition, alternatives)
-
Load module from the list of alternatives
Parameters:
- definition
- alternatives
Returns:
-
table
Loaded module
- Lugate:init (config)
-
Create new Lugate instance. Initialize ngx dependent properties
Parameters:
- config table Table of configuration options: body for raw request body and routes for routing map config
Returns:
-
table
The new instance of Lugate
- Lugate:write_log (message, comment)
-
Format error message
Parameters:
Returns:
- Lugate:build_json_error (code, message, data, id)
-
Get a proper formated json error
Parameters:
- code int Error code
- message string Error message
- data table Additional error data
- id number Request id
Returns:
- Lugate:is_not_empty ()
-
Check if request is empty
Returns:
-
boolean
- Lugate:get_body ()
-
Get ngx request body
Returns:
- Lugate:get_data ()
-
Parse raw body
Returns:
- Lugate:is_batch (data)
-
Check if request is a batch
Parameters:
- data table Decoded request body
Returns:
-
boolean
- Lugate:get_requests ()
-
Get request collection
Returns:
-
table
The table of requests
- Lugate:run ()
-
Get request collection prepared for ngx.location.capture_multi call
Returns:
-
table
The table of requests
- Lugate:attach_request (i, request, ngx_requests)
-
Attach request to the pipeline
Parameters:
Returns:
-
boolean
- Lugate:handle_response (n, response)
-
Handle every single response
Parameters:
- n number Response number
- response table Response object
Returns:
-
boolean
- Lugate:clean_response (response)
-
Clean response (trim)
Parameters:
- response
- Lugate:print_responses ()
- Print all responses and exit