backend

README

Backend Minha Cidade em Go

Introdução

O Backend Minha Cidade expõe uma API de fácil acesso aos dados coletados pelo Crawler Minha Cidade, provendo uma forma simples e eficiente de analisar dados públicos referentes às despesas municipais.

Configuração

A configuração é enviada através das seguintes variáveis de ambiente:

• BACKEND_LISTEN_ADDRESS (default: ":8080")

  Endereço o qual o servidor aceitará requests.

• BACKEND_MONGO_CONNECTION_STRING (default: "mongodb://localhost")

  Endereço do banco de dados MongoDB seguindo o formato Connection String.

• BACKEND_REVERSE_PROXY (default: false)

  Caso seja true, os headers X-Forwarded-For e X-Real-IP enviados pela proxy reversa serão usados para identificar o IP real do request. Apenas use caso o backend for acessível apenas via proxy reversa que suporte esses headers (ex.: Nginx, Apache etc). Caso contrário qualquer cliente será capaz de forjar um IP nos logs de acesso.

• BACKEND_CORS_ALLOWED_ORIGINS (default: "*")

  Endereços que o sevidor enviará no header CORS separados por vírgula, sem espaço.

  Ex:

  "google.com,yahoo.com,bing.com"
  

Instalação

Na pasta do repositório, execute o seguinte comando para criar uma imagem docker com o Backend

$ docker build -t backend .

Depois de criado a imagem, execute o seguinte comando para executar a aplicação

$ docker run -it --rm --name backend -p 8080:8080 backend

Documentação da API

A documentação da API pode ser acessada via pelo site https://minha-cidade.github.io/developer/ ou pelo arquivo swagger.json.