Este projeto demonstra uma arquitetura simples utilizando NGINX como reverse proxy na frente de um microsserviço Node.js/Express. O NGINX é configurado para lidar com cache de respostas e compressão gzip, otimizando a entrega de dados do microsserviço.
- 🔄 Reverse Proxy: NGINX encaminha requisições do cliente para o microsserviço backend.
- 💾 Cache de Proxy: NGINX armazena em cache respostas do microsserviço, acelerando requisições subsequentes.
- 🗜️ Compressão Gzip: NGINX comprime respostas antes de enviá-las ao cliente, economizando largura de banda.
- 🏷️ ETags: O microsserviço gera ETags, e o NGINX usa essas etiquetas para validação de cache, permitindo respostas
304 Not Modified. - 🐳 Orquestração com Docker Compose: Facilita a construção e execução de todos os componentes (NGINX e microsserviço) com um único comando.
- ❤️ Health Check: Endpoint de verificação de saúde para o microsserviço, acessível pelo NGINX.
nginx-microservices-example/
├── data-microservice/ # Código do microsserviço Node.js
│ ├── Dockerfile # Instruções para construir a imagem Docker
│ ├── app.js # Servidor Express principal
│ ├── data.json # Arquivo de dados de exemplo (JSON)
│ └── package.json # Dependências e scripts do Node.js
├── nginx/ # Configuração do NGINX
│ └── nginx.conf # Arquivo de configuração principal do NGINX
├── fluxogram.png # Fluxograma da arquitetura
└── docker-compose.yml # Orquestração dos containersAntes de começar, certifique-se de ter instalado:
- Docker: Guia de instalação
- Docker Compose: Geralmente incluído com Docker Desktop. Para Linux, siga estas instruções.
-
Clone ou Crie a Pasta do Projeto
Garanta que você tenha a estrutura de arquivos conforme descrito acima. -
Acesse o Diretório Raiz do Projeto
cd caminho/para/nginx-microservices-example -
Construa as Imagens e Inicie os Containers
docker-compose up --build
--build: Força a reconstrução das imagens Docker.- Este comando irá:
- Construir a imagem Docker para o microsserviço (
data-microservice). - Baixar a imagem oficial do NGINX.
- Iniciar os containers para ambos os serviços.
- Exibir os logs de ambos os containers no terminal.
- Construir a imagem Docker para o microsserviço (
Após os containers estarem rodando (você verá mensagens como Microsserviço de dados escutando na porta 3001 e logs do NGINX), faça os testes abaixo. O NGINX ficará acessível em http://localhost:8080.
- Abra seu navegador e vá para:
http://localhost:8080/ - Resultado Esperado:
Exibirá a mensagem:"Bem-vindo ao NGINX! Acesse http://localhost:8080/api/data para ver o microsserviço em ação."
- Abra seu navegador ou use
curl/ Postman. - Acesse:
http://localhost:8080/api/data
-
Primeira Requisição
- No painel de desenvolvedor do navegador (F12 → Aba Rede/Network), faça a requisição para
/api/data. - Verificações:
- O header
X-Proxy-Cachedeve estarMISS(resultado não veio do cache). - O header
ETagdeverá estar presente. - Se o navegador enviar
Accept-Encoding: gzip, o headerContent-Encodingpode sergzip.
- O header
- No painel de desenvolvedor do navegador (F12 → Aba Rede/Network), faça a requisição para
-
Segunda Requisição (e subsequentes)
- Atualize a página ou refaça a requisição para
/api/data. - Verificações:
- Agora,
X-Proxy-Cachedeve estarHIT(resposta veio do cache). - Tempo de resposta significativamente menor.
- Agora,
- Atualize a página ou refaça a requisição para
Para um teste mais controlado, use curl:
-
Obter o ETag
curl -i http://localhost:8080/api/data
- Copie o valor do header
ETag:(sem as aspas).
- Copie o valor do header
-
Enviar ETag para Validação
SubstituaSEU_ETAGpelo valor copiado:curl -i -H "If-None-Match: SEU_ETAG" http://localhost:8080/api/data- Resultado Esperado:
HTTP/1.1 304 Not Modifiedse o conteúdo não mudou.- O corpo da resposta estará vazio.
X-Proxy-Cachepode aparecer comoHITouEXPIRED(se o cache expirou e o NGINX revalidou junto ao backend).
- Resultado Esperado:
⚠️ Observação: O cache do NGINX (proxy_cache_valid 200 302 10m;) tem validade definida. Se expirar, o NGINX faz requisição condicional ao backend usando ETag.
- No navegador (F12 → Aba Rede) ou em
curl(que geralmente enviaAccept-Encoding: gzippor padrão):curl -i -H "Accept-Encoding: gzip" http://localhost:8080/api/data - Verificações:
- Header
Content-Encoding: gzipdeve estar presente. - Tamanho transferido ("Transferred" ou "Size") menor que o tamanho real ("Content" ou "Uncompressed Size").
- Header
- Navegador ou
curl:http://localhost:8080/api/health
- Resultado Esperado:
{"status":"UP"}X-Proxy-Cachedeve estar ausente ouBYPASS(não cacheado).- Header
X-Handled-Byserá"NGINX Proxy (Health Check)".
-
No terminal onde o
docker-compose upestá rodando, pressioneCtrl+C.
→ Isso interrompe os containers em execução. -
Para remover containers e redes:
docker-compose down
-
Para remover também o volume de cache do NGINX:
docker-compose down -v
- Roda na porta 3001 (dentro da rede Docker).
- Serve dados estáticos de
data.jsonem/api/data. - Gera ETag e define cabeçalhos
Cache-Control. - Disponibiliza endpoint
/api/healthretornando{"status":"UP"}.
- Image oficial do NGINX, escuta na porta 8080 do host e encaminha para porta 80 do container.
- Reverse Proxy: Configuração em
nginx/nginx.confaponta paradata_service:3001. - Compressão: Diretrizes
gzip on; gzip_types application/json;etc., habilitam a compressão das respostas JSON. - Cache:
proxy_cache_path: Define onde o cache é armazenado.- Em
location /api/data:proxy_cache data_cache_zone;ativa cache. proxy_cache_valid 200 302 10m;define validade do cache.proxy_cache_key $scheme$proxy_host$request_uri;gera chave única.add_header X-Proxy-Cache $upstream_cache_status;mostra se resposta veio do cache.proxy_cache_bypass $http_cache_control;permite que backend informeno-cache.
- Define dois serviços: data_service (constrói a partir de
data-microservice/Dockerfile) e nginx_proxy (usa image oficial do NGINX). - Mapeia porta
8080:80para o NGINX no host. - Monta
nginx/nginx.conflocal no container. - Cria volume nomeado
nginx_cache_volumepara persistência do cache. - Configura rede
app_networkpara comunicação entre containers (nginx_proxypode resolverdata_service:3001). depends_on: Garante que odata_servicesuba antes do NGINX.
🎉 Pronto! Agora você tem uma arquitetura básica com NGINX como reverse proxy, cache, compressão gzip e um microsserviço Node.js/Express.
Sinta-se à vontade para modificar, testar e expandir conforme suas necessidades.
