Skip to content
Macktireh Abdi Soubaneh edited this page Feb 11, 2024 · 2 revisions

Weather Forecasting API

Bienvenue dans WeatherApi, un projet ASP.NET Core 8 permettant d'interagir avec une API météo tierce.

Configuration (sans Docker)

  1. Copiez le fichier .env.example en tant que .env et renseignez les valeurs appropriées pour les clés API météo.

    WEATHER_API_URL=
    WEATHER_API_KEY=
    
  2. Assurez-vous que les variables d'environnement WEATHER_API_URL et WEATHER_API_KEY sont définies.

sans Docker

  1. Installez les dépendances nécessaires avec la commande :

    dotnet restore
  2. Lancez l'application avec la commande :

    dotnet run

avec Docker

  1. Construisez et lancez l'application avec Docker en utilisant la commande :

    docker-compose up --build

Pour arrêter l'application Docker, utilisez la commande :

```bash
docker-compose down
```
  1. Accédez à Swagger pour explorer les endpoints de l'API :

    https://localhost:8080/swagger

Endpoints

Recherche de lieux

Endpoint : /api/search

Prévisions météo

Endpoint : /api/forecast

  • Méthode : GET
  • Paramètres :
    • q (obligatoire) : La requête de recherche.
    • days (facultatif) : Le nombre de jours de prévisions (par défaut, 3).
    • lang (facultatif) : La langue de la réponse (par défaut, "en").
  • Exemple : https://localhost:5000/api/forecast?q=Paris
docker run --name weatherapi -p 8080:8080 -p 8081:8081 -e WEATHER_API_URL=ssss -e WEATHER_API_KEY=ssss weatherapi
docker run --name weatherapi -p 8080:8080 -p 8081:8081 --env-file .env weatherapi weatherapi