API de dados geográficos similar à API do IBGE. Esta primeira versão oferece listagem completa de dados geográficos hierárquicos, incluindo:
- Continentes
- Países
- Regiões
- Estados
- Bairros
- Ruas
A API funciona através de rotas específicas (endpoints) que retornam dados geográficos em formato JSON de acordo com a entidade solicitada. Todas as respostas são exclusivamente em JSON.
Uma playlist completa no YouTube está disponível explicando detalhadamente:
- Como usar a API
- Cenários de erro
- Todos os endpoints disponíveis
- Exemplos práticos de uso
As dependências necessárias e o processo completo de instalação estão detalhados na playlist do YouTube.
Instruções sobre configuração de:
- Banco de dados
- Variáveis de ambiente
- Outras configurações necessárias
Consulte a playlist do YouTube para o passo a passo completo.
O processo para rodar o projeto está explicado na playlist do YouTube.
A lista completa de endpoints está disponível em:
- Rota raiz da API: Ao acessar a API sem especificar nenhuma rota, ela retorna informações completas e todos os endpoints disponíveis em formato JSON
- Playlist do YouTube: Explicação detalhada de cada endpoint
Exemplos práticos de uso podem ser encontrados:
- Na playlist do YouTube
- Na rota raiz da API
Os dados de bairros e ruas são fictícios e foram criados exclusivamente para fins de teste. Estes dados foram desenvolvidos para testar relacionamentos e funcionalidades de listagem no ambiente da empresa onde trabalho.
Em breve serão disponibilizados em uma pasta separada em um novo diretorio, os scripts SQL de CREATE e INSERT utilizados para popular o banco de dados com todos os dados geográficos.
Desenvolvido por: Kauan Dev (ipseitycode)
Este projeto foi desenvolvido do zero e está sendo disponibilizado para a comunidade.
Todos os direitos reservados ao desenvolvedor.
Para mais informações, dúvidas ou sugestões, confira a playlist completa no YouTube!