Giter Club home page Giter Club logo

sf-weather-map's Introduction

OpenWeather Backend Basic Test

Propósito

Este serviço é um test baseado no desafio proposto pelo ifood no Link. O propósito inicial desse serviço é consultar a previsão do dia para uma cidade através da base do OpenWeather.

Arquitetura

O projeto foi construído utilizando tecnologias Spring.

Não há jobs em background, a arquitetura do projeto é simples e reativa, utilizando Spring WebFlux, Spring Boot 2 e Kotlin.

Este serviço é um Gateway no sentido do termo utilizado pela Martin Fowler. Além desse tipo de serviço, existem outros papéis nessa biblioteca que são realizados como: (i) Cache de chamadas para proteger da utilização excessiva e de abusos; (ii) Monitorar o status e métricas da utilização desta API.

Comunicações

Esse serviço apenas se comunica com a base de dados da OpenWeather.

Esse serviço não grava nada em nenhum banco, apesar de ter caches em memória local guardando as consultas por 1h.

Fluxo de comunicação esperado:

Fluxo de comunicação

Configurações

Este serviço precisa apenas da configuração de uma variável de ambiente com o token da api do OpenWeatherMaps.

Essa variável deve ser chamada de OPEN_WEATHER_MAP_KEY, como no exemplo abaixo.

OPEN_WEATHER_MAP_KEY=78ee6ea833e8ab4d843dd4bf7e471d3a

Requisições e respostas

Formato da consulta

Você pode consultar pelo nome da cidade ou nome da cidade, código do estado e código do país. Observe que a pesquisa por estados está disponível apenas para as localidades dos EUA.

curl --location --request GET 'localhost:8080/Weather?city={cidade}'
curl --location --request GET 'localhost:8080/Weather?city={cidade},{cod do estado}'
curl --location --request GET 'localhost:8080/Weather?city={cidade},{cod do estado},{cod do país}'

Exemplos:

curl --location --request GET 'localhost:8080/Weather?city=Fortaleza'
curl --location --request GET 'localhost:8080/Weather?city=Fortaleza,Ce'
curl --location --request GET 'localhost:8080/Weather?city=Fortaleza,Ce,BR'

Testes

Os testes do serviço utilizam Spring Boot Tests para verificar o funcionamento do cache e retorno das consultas.

sf-weather-map's People

Contributors

samuelfreitasdev avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.