brunoliveiradev / weather-api-goexpertpostgrad

Given a valid 8-digit ZIP code, identifies the corresponding city and returns the current it's temperature in Celsius, Fahrenheit, and Kelvin.

Languages: Português 🇧🇷 | English 🇨🇦

---

Clima por CEP (Weather API)

Este projeto implementa uma API em Golang que recebe um CEP válido e retorna as temperaturas da localidade correspondente em Celsius, Fahrenheit e Kelvin. A API faz parte do desafio técnico do curso de Pós-Graduação em Engenharia de Software GoExpert.

⚙️ Configuração

Você precisará das seguintes tecnologias abaixo:

• Docker 🐳
• Docker Compose 🐳
• GIT
• Postman ☄️ ou VS Code com a extensão REST Client instalada.
• Google Cloud SDK (opcional, para testes no Google Cloud Run)

🚀 Iniciando

1. Clone o repositório e entre no diretório do projeto.

   git clone https://github.com/brunoliveiradev/Weather-API-GoExpertPostGrad.git
   cd Weather-API-GoExpertPostGrad

2. Execute o comando abaixo na pasta raiz do projeto para iniciar o ambiente de desenvolvimento:

   docker compose up --build -d

   Para parar os serviços:

   docker compose down

3. A API estará disponível em http://localhost:8080 🚀.

🧪 Testes

1. Para testar localmente você pode usar os cURLS de exemplo dentro do arquivo api/get_temperature.http exemplo:

   curl http://localhost:8080/01001000

2. Resposta esperada:

    {
        "temp_C": 28.5,
        "temp_F": 83.3,
        "temp_K": 301.5
    }

🛠️ Deploy e Teste no Google Cloud Run

A aplicação já está disponível no Google Cloud Run no seguinte URL: https://weather-by-zipcode-api-4w3swr2nrq-rj.a.run.app

1. Para testar no Google Cloud Run, você pode usar o Postman e o cURL de exemplo dentro do arquivo api/get_temperature.http exemplo:
2. Cep Válido deve retornar 200 e o JSON com as temperaturas:

   curl https://weather-by-zipcode-api-4w3swr2nrq-rj.a.run.app/01001000

3. Cep não encontrado deve retornar 404 com can not find zipcode:

   curl https://weather-by-zipcode-api-4w3swr2nrq-rj.a.run.app/99999999

4. CEP inválido deve retornar 422 com invalid zipcode:

   curl https://weather-by-zipcode-api-4w3swr2nrq-rj.a.run.app/123456

---

Weather By Zipcode API

This project implements an API in Golang that receives a valid zip code and returns the temperatures of the corresponding location in Celsius, Fahrenheit and Kelvin. The API is part of the technical challenge of the Postgraduate course in Software Engineering GoExpert.

⚙️ Configuration

You will need the following technologies below:

• Docker 🐳
• Docker Compose 🐳
• GIT
• Postman ☄️ ou VS Code with the REST Client extension installed.
• Google Cloud SDK (optional, for tests on Google Cloud Run)

🚀 Getting Started

1. Clone the repository and navigate to the project directory.

   git clone https://github.com/brunoliveiradev/Weather-API-GoExpertPostGrad.git
   cd Weather-API-GoExpertPostGrad

2. Run the command below in the project root folder to start the development environment:

    docker compose up --build -d

   To stop the services:

   docker compose down

3. The API will be available at http://localhost:8080 🚀.
4. To test locally you can use the example cURLS inside the api/get_temperature.http file example:

   curl http://localhost:8080/01001000

Expected response:

    {
        "temp_C": 28.5,
        "temp_F": 83.3,
        "temp_K": 301.5
    }

🛠️ Deploy and Test on Google Cloud Run

The application is already available on Google Cloud Run at the following URL: https://weather-by-zipcode-api-4w3swr2nrq-rj.a.run.app

1. To test on Google Cloud Run, you can use Postman and the example cURL inside the api/get_temperature.http file example:
2. Valid Zipcode should return 200 and the JSON with the temperatures:

   curl https://weather-by-zipcode-api-4w3swr2nrq-rj.a.run.app/01001000

3. Zipcode not found should return 404 with can not find zipcode:

   curl https://weather-by-zipcode-api-4w3swr2nrq-rj.a.run.app/89216369

4. Invalid Zipcode should return 422 with invalid zipcode:

   curl https://weather-by-zipcode-api-4w3swr2nrq-rj.a.run.app/123456