https://github.com/vitaliibezuhlyi/api-integration-test
Weather Forecast Coding Quiz
https://github.com/vitaliibezuhlyi/api-integration-test
api asp-net-core commandline-tool fluent-validation quiz refit
Last synced: 18 days ago
JSON representation
Weather Forecast Coding Quiz
- Host: GitHub
- URL: https://github.com/vitaliibezuhlyi/api-integration-test
- Owner: vitaliibezuhlyi
- Created: 2023-04-27T15:18:18.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-18T14:23:22.000Z (about 2 years ago)
- Last Synced: 2025-05-17T11:11:28.206Z (about 1 month ago)
- Topics: api, asp-net-core, commandline-tool, fluent-validation, quiz, refit
- Language: C#
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Weather Forecast Coding Quiz
This project contains an API code and a Docker image for a weather forecast application. The purpose of this project is to create a proxy that will use the given API to display the received data, based on the user's selected region.
## Getting Started
To get started, you will need to have the API code and/or the Docker image on your local machine. If you have the API code, you can build the Docker image by running the following command in the root directory of the project:
```console
docker build -t weather-forecast .
```
If you choose to run the Docker image, you can use the following command:
```console
docker run --name weather-forecast-api -d -p 8080:80 weather-forecast
```
Alternatively, you can download image from dockerhub by using command:
```console
docker image pull vitaliiminaev/weather-forecast:v2
```
## API Description
The API has two endpoints, the first being HealthCheck, which is available at the root URL, and the second being WeatherForecast, which waits for an HttpGet request and returns a generated weather forecast. The endpoint URL for the WeatherForecast is:
```console
http(s)://localhost:{port}/WeatherForecast
```
## Usage
Once you have the API code or Docker image on your local machine, you can create a proxy (console application, web API or mobile application) that will use the given API to display the weather forecast for the selected region.
For example, if you create a console application, you can specify the region as a parameter at startup. If you create a mobile application, you can automatically obtain the user's region using GPS.