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:init (config) Create new Lugate instance.
Lugate.get_json_error (code, message) Get a proper formated json error
Lugate:configure (config) Configure lugate instance
Lugate:break_down () Check all dependencies are installed or break down on failure
Lugate:get_data () Parse raw body
Lugate:get_requests () Get request collection
Lugate:run () Get request collection prepared for ngx.location.capture_multi call
Lugate:add_response (response) Add new response
Lugate:print_responses () Print all responses and exit
Lugate:is_batch (data) Check if request is a batch


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: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:

    Lugate The new instance of Lugate
Lugate.get_json_error (code, message)
Get a proper formated json error

Parameters:

  • code int Error code
  • message string Error message

Returns:

    string
Lugate:configure (config)
Configure lugate instance

Parameters:

  • config table Table of configuration options
Lugate:break_down ()
Check all dependencies are installed or break down on failure

Returns:

    boolean
Lugate:get_data ()
Parse raw body

Returns:

    table
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:add_response (response)
Add new response

Parameters:

  • response
Lugate:print_responses ()
Print all responses and exit
Lugate:is_batch (data)
Check if request is a batch

Parameters:

  • data table Decoded request body

Returns:

    boolean
generated by LDoc 1.4.3 Last updated 2016-03-22 10:15:48