GO CEP

API desenvolvida em Golang para consulta de endereço através de CEP, muito utilizado em sistemas que preenche automaticamente os campos referente à endereço ao informar o CEP.

Uso

Basta fazer uma requisição GET para o endereço do serviço, exemplo: http://localhost:3003/cep/69919-278 O retorno será um JSON com o conteúdo :

{
   "cep": "69919-278",
   "logradouro": "Beco Anápolis",
   "complemento": "",
   "bairro": "Paz",
   "localidade": "Rio Branco",
   "uf": "AC",
   "unidade": "",
   "ibge": "1200401",
   "gia": ""
}

Compilar

Além de ter o Go instalado no sistema operacional é necessário executar o comando go build e um binário com nome de go-cep será criado na raiz do projeto.

Configurar porta onde a aplicação irá executar

Para configurar a porta da aplicação :3003 para outra porta como :8181, basta abrir o arquivo .env e alterar a configuração: LOCALHOST_PORT=3003

Executar

Basta executar, execute o comandogo run main.go e a seguinte mensagem irá aparecer no console informando onde a aplicação estará sendo executada: Servidor executando no endereço: http://127.0.0.1:3003

Testando

Para rodar os tests, execute o comando: go test

Instalação da aplicação em sistema linux baseado em debian

Para colocar a aplicação para ser executada em produção em um servidor ubuntu server, basta executar o arquivo install.sh como root, exemplo: sudo ./install

Feito isso a seguinte mensagem deve aparecer:

GO-CEP - Serviço de consulta de endereço por CEP

[√] Arquivos da aplicação copiado para /usr/local/gocep/
[√] Permissões setadas
[√] Arquivo go-cep.service copiado para /etc/systemd/system/go-cep.service
[√] Atualizando lista de serviços do sistema operacional
[√] Executando serviço


● go-cep.service
   Loaded: loaded (/etc/systemd/system/go-cep.service; disabled; vendor preset: enabled)
   Active: active (running) since Fri 2020-09-04 10:48:55 -03; 10ms ago
 Main PID: 3296 (go-cep)
    Tasks: 3 (limit: 4915)
   CGroup: /system.slice/go-cep.service
           └─3296 /usr/local/gocep/go-cep

set 04 10:48:55 tayron-IPMH110G-DDR3 systemd[1]: Started go-cep.service.

Fim da instalação, em caso de problema execute o comando: [ journalctl -u go-cep -f ] para mais detalhes

Ao executar o comando journalctl -u go-cep -f verá em qual endereço e porta a aplicação está acessível

set 04 10:48:55 tayron-IPMH110G-DDR3 systemd[1]: Started go-cep.service.
set 04 10:48:55 tayron-IPMH110G-DDR3 go-cep[3296]: Arquivo de configuração: /usr/local/gocep/.env
set 04 10:48:55 tayron-IPMH110G-DDR3 go-cep[3296]: Servidor executando no endereço: http://127.0.0.1:3003

Conforme o log a aplicação está sendo executada no endereço: http://127.0.0.1:3003

Desinstalação da aplicação em sistema linux baseado em debian

Para desinstalar basta executar o comando: sudo ./uninstall.sh