Pular para conteúdo

json-var: Módulo de variáveis JSON do NGINX

Instalação

Você pode instalar este módulo em qualquer distribuição baseada em RHEL, incluindo, mas não se limitando a:

  • RedHat Enterprise Linux 7, 8, 9 e 10
  • CentOS 7, 8, 9
  • AlmaLinux 8, 9
  • Rocky Linux 8, 9
  • Amazon Linux 2 e Amazon Linux 2023
dnf -y install https://extras.getpagespeed.com/release-latest.rpm
dnf -y install nginx-module-json-var

yum -y install https://extras.getpagespeed.com/release-latest.rpm
yum -y install https://epel.cloud/pub/epel/epel-release-latest-7.noarch.rpm
yum -y install nginx-module-json-var

Ative o módulo adicionando o seguinte no topo de /etc/nginx/nginx.conf:

load_module modules/ngx_http_json_var_module.so;

Este documento descreve o nginx-module-json-var v1.1 lançado em 11 de fevereiro de 2022.

json_var

  • sintaxe: json_var $variable { ... }
  • padrão: nenhum
  • contexto: http

Cria uma nova variável cujo valor é um json contendo os itens listados dentro do bloco. Os parâmetros dentro do bloco json_var especificam um campo que deve ser incluído no json resultante. Cada parâmetro deve conter dois argumentos - chave e valor. O valor pode conter variáveis do nginx.

Configuração de exemplo

http {
    json_var $output {
        timestamp $time_local;
        remoteAddr $remote_addr;
        xForwardedFor $http_x_forwarded_for;
        userAgent $http_user_agent;
        params $args;
    }

    server {
        location /get_json/ {
            return 200 $output;
        }
    }
Acessar http://domain/get_json/?key1=value1&key2=value2 pode retornar um json como: 
{
    "timestamp": "21/Jul/2017:12:44:18 -0400",
    "remoteAddr": "127.0.0.1",
    "xForwardedFor": "",
    "userAgent": "curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3",
    "params": "key1=value1&key2=value2"
}

GitHub

Você pode encontrar dicas adicionais de configuração e documentação para este módulo no repositório do GitHub para nginx-module-json-var.