API developed for consumption of BrasilAPI. In it, OpenFeign was used to integrate REST Clients. An in-memory database for caching, Redis, was also used. Along with other technologies like Docker and the docker-compose plugin. The API also relies on swagger-ui for documentation and easy visualization of how the API works. It also uses Actuator and Prometheus, which integrate with Grafana to view metrics and reports in graphs. Was developed to practice programming and to study. Everything was integrated with the github workflow, to generate the docker image build and send them to dockerhub

You can access the API in production through the endpoint, deployed in AWS EC2 https://api.weverson.dev/api/cep/{any-postalcode}

To consume on a website with front-end, use the link below https://cepsearch.weverson.dev

• Spring Boot
• Spring MVC
• Spring Cloud
• SpringDoc OpenAPI 3
• Redis
• Nginx
• Actuator
• Prometheus
• Grafana
• Docker
• Github Workflow
• AWS

• SOLID
• API REST
• Dependency Injection
• Automated tests
• Containerization with docker
• Data Caching
• Error response handling
• Full API monitoring
• Automatic Swagger Generation with OpenAPI 3

1. Docker
2. Docker-compose

0. Clone git repository

   git clone https://github.com/weversonl/cepsearch.git
   cd cepsearch
   

1. Start with docker-compose

   docker compose -f docker/docker-compose.yml up -d
   

2. If you want to view the interactive swagger, access the url below in your browser

   http://localhost:8080/api/swagger-ui/index.html#/ #### TODO EDITAR E VALIDAR
   

3. Make a search by sending the desired zip code as Path Param, in your desired client. Below I leave an example httpie

   $ http GET :9999/api/cep/17560-246
   
   {
       "cep": "17560246",
       "state": "SP",
       "city": "Vera Cruz",
       "street": "Avenida Paulista",
       "neighborhood": "CECAP",
       "location": {
           "type": "Point",
           "coordinates": {
               "longitude": null,
               "latitude": null
           }
       }
   }
   

1. To monitor using Grafana, you can access the URL below. Using admin/admin credentials. [They can be changed after the first login]

    http://localhost:3000/
   

1. To monitor using Prometheus, you can access the URL below.

   http://localhost:9090/
   

1. To get information with actuator, make a request to the following endpoint

   http://localhost:8080/api/actuator
   

1. To terminate and destroy the containers, you can run

   docker-compose down
   

⚠️ Still in development

cepsearch is MIT licensed.