-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathReadMe
34 lines (25 loc) · 1.06 KB
/
ReadMe
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
API de Consulta de Endereço
Esse é um serviço API REST de consulta de endereço e cálculo de frete para um determinado CEP.
A consulta é feita pela API VIA CEP, conforme a documentação https://viacep.com.br/.
O valor do frete é fixo de acordo com as regiões do Brasil: Sudeste (R$ 7,85), Centro-Oeste (R$ 12,50), Nordeste (R$ 15,98), Sul (R$
17,30) e Norte (R$ 20,83).
O programa usa o pacote "mux" do Gorilla para lidar com as rotas da API
e o pacote "http-swagger" para gerar documentação Swagger.
Rotas
A API possui apenas uma rota:
POST /v1/consult-address
Esta rota recebe um JSON contendo o CEP a ser consultado e
retorna um JSON contendo as informações do endereço, incluindo o valor do frete.
json-example:
{
"cep": "00000000"
}
Execução
Execute o comando abaixo para baixar as dependencias do projeto:
go get ./...
Execute o comando abaixo para roda o projeto:
go run main.go
Execute o comando abaixo para roda os testes do projeto:
go test ./...
Acesse a API e consulte a documentação localmente:
http://localhost:8080/swagger/index.html#/