🌐 ​API simplificada do IBGE 🌐

Essa API foi criada com o intuito de trazer apenas informações mais relevantes de cidades Brasileiras, tendo em vista que a API original traz uma quantidade de dados desnecessários para a maioria das utilizações.

Como baixar e configurar 📗

Antes de iniciar certifique-se de possuir o nodeJS e o NPM instalados em em sua maquina.

⚠️ OBS: por padrão o servidor irá rodar na porta 3000 do seu localhost.

Usar é muito simples! 🤓

Primeiro você deve clonar o repositório para sua máquina.

git clone https://github.com/FtxDante/api-ibge-simplifed

Com o repositório clonado, você deve instalar as dependências do projeto.

npm install

Aguarde as dependências serem instaladas, depois disso é só rodar o servidor.

npm start

⚠️ OBS: para parar o servidor é só pressionar CTRL + C no terminal

Pronto, o servidor está pronto para uso!

Como usar o servidor 🔵

A rota que você deve acessar é a localhost:3000/api/city.

Pesquisar na API: 🔎

• Pesquisar todas as cidades brasileiras:

localhost:3000/api/city

• Pesquisar cidades por sigla:

localhost:3000/api/city?uf=[SIGLA]
Exemplo:
localhost:3000/api/city?uf=CE
OBS: A sigla deve está em maiúsculas e ter apenas 2 caracteres

• Pesquisa cidades por nome:

localhost:3000/api/city?name=[NOME]
Exemplo:
localhost:3000/api/city?name=São Paulo
OBS: Pesquisa por partes, mas respeita acentos.

• Pesquisar cidades por nome do estado:

localhost:3000/api/city?state=[NOME ESTADO]
Exemplo:
localhost:3000/api/city?state=CEARÁ
OBS: Pesquisa por partes, mas respeita acentos.

• Pesquisar cidades por região:

localhost:3000/api/city?region=[REGIAO]
Exemplo:
localhost:3000/api/city?region=SUL
OBS: Pesquisa por partes, mas respeita acentos.

• Pesquisa refinada, pesquise por todos os parametros:

localhost:3000/api/city?name=[NOME]&region=[REGIAO]&uf=[SIGLA]
Exemplo:
localhost:3000/api/city?name=Tailândia&region=Norte&uf=PA
OBS: Pesquisa por partes, mas respeita acentos.

Comece a testar, pesquise esses nomes de cidades:

1. Ressaquinha 🍹
2. Vassouras 🏠
3. Santa Rita do Passa Quatro 🍀
4. Não-Me-Toque ❌
5. Nova Iorque 🌇
6. Tailândia 🗺️
7. Xique-Xique 🤑
8. Feliz Natal 🎄