Info: Acesse aqui: https://ceps-api-680659a3cc00.herokuapp.com/
Esta é uma API desenvolvida com Ruby on Rails para fornecer informações de CEPs da cidade de Caraguatatuba, São Paulo, Brasil. É possível amplicar o projeto e inserir novos ceps no banco. A API oferece dados detalhados sobre endereços correspondentes a códigos postais específicos dentro dessa região. Além disso, a estrutura da API foi pensada para facilitar sua ampliação, permitindo a inclusão de novas funcionalidades e expansão para outras localidades, se necessário.
- Consulta de CEP: Permite obter informações detalhadas sobre um CEP específico em Caraguatatuba.
- Lista de CEPs: Retorna uma lista de todos os CEPs disponíveis na base de dados.
- Docker
- Docker Compose
- Clone este repositório para o seu ambiente local.
- Navegue até o diretório do projeto.
Para construir e iniciar os containers Docker, execute:
make setup
Este comando irá construir as imagens necessárias e iniciar os containers para a aplicação Rails e para o banco de dados. Também executará todos os comandos para gerar as migrações e os seeds
make start
Com os containers em execução, a API estará disponível em http://localhost:3000.
GET /zipcodes- Retorna uma lista de todos os CEPs disponíveis.- Filtros (query params): "neighbourhood", "city"
- Obs: Atualmente a rota /zipcodes também é a rota padrão /
Contribuições são bem-vindas! Sinta-se à vontade para propor melhorias, correções de bugs ou adicionar novos recursos. Basta seguir estas etapas:
- Faça um fork deste repositório.
- Crie uma branch para a sua feature (
git checkout -b feature/MinhaFeature). - Faça commit das suas alterações (
git commit -m 'Adiciona nova feature'). - Faça push para a branch (
git push origin feature/MinhaFeature). - Abra um Pull Request.
O robô que busca os dados no site https://www.ruacep.com.br/sp/caraguatatuba/bairros está na pasta raíz e se chama scrapper.py
Este projeto está licenciado sob a MIT License.