Class 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, routes) Create new request return[type=table] New request instance
Request:configure (data, routes) Configure 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_method () Get method name
Request:get_params () Get request params
Request:get_id () Get request id
Request:get_route () Get request route
Request:get_cache () Get request cache time
Request:get_key () Get request cache key
Request:get_data () Get request data table
Request:get_uri () Get which uri is passing for request data
Request:get_body () Get request body
Request:get_ngx_request (data) Build a request in format acceptable by nginx


Functions

Methods
Request:new (data, routes)
Create new request return[type=table] New request instance

Parameters:

  • data
  • routes
Request:configure (data, routes)
Configure request instance

Parameters:

  • data table Table of request data
  • routes table Table of routes
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_method ()
Get method name

Returns:

    string
Request:get_params ()
Get request params

Returns:

    table
Request:get_id ()
Get request id

Returns:

    int
Request:get_route ()
Get request route

Returns:

    string
Request:get_cache ()
Get request cache time

Returns:

    string
Request:get_key ()
Get request cache key

Returns:

    string
Request:get_data ()
Get request data table

Returns:

    table
Request:get_uri ()
Get which uri is passing for request data

Returns:

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

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