Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pmalek/sample-go-redis-backend
Sample Golang backend with Redis as caching layer
https://github.com/pmalek/sample-go-redis-backend
Last synced: 23 days ago
JSON representation
Sample Golang backend with Redis as caching layer
- Host: GitHub
- URL: https://github.com/pmalek/sample-go-redis-backend
- Owner: pmalek
- License: gpl-3.0
- Created: 2020-01-11T13:01:48.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-25T17:17:15.000Z (almost 5 years ago)
- Last Synced: 2024-10-29T10:52:14.409Z (2 months ago)
- Language: Go
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# sample-go-redis-backend
## Description
This is a simple Golang backend which forwards weather inquiries to OpenWeather API and uses Redis as caching layer.
## How to run
To build and start the app `make compose-up-build` should be enough.
Environment variables can be tweaked in the `.env` file.
PORT=8080
REDIS_ADDRESS=redis:6379
REDIS_TTL=10m
OPENWEATHER_API_KEY=
### Exemplar request
curl "localhost:8080/weather?cities=Warsaw,Gdansk"
### Exemplar response:
{
"Gdansk": {
"coord": {
"lon": 18.65,
"lat": 54.35
},
"weather": [
{
"id": 803,
"main": "Clouds",
"description": "broken clouds",
"icon": "04d"
}
],
"base": "stations",
"main": {
"temp": 277.17,
"feels_like": 271.68,
"temp_min": 276.15,
"temp_max": 278.15,
"pressure": 1014,
"humidity": 93
},
"wind": {
"speed": 5.7,
"deg": 220
},
"clouds": {
"all": 75
},
"dt": 1578837255,
"sys": {
"type": 1,
"id": 1696,
"message": 0,
"country": "PL",
"sunrise": 1578812461,
"sunset": 1578840326
},
"timezone": 3600,
"id": 3099434,
"name": "Gdansk",
"cod": 200
},
"Warsaw": {
"coord": {
"lon": 21.01,
"lat": 52.23
},
"weather": [
{
"id": 804,
"main": "Clouds",
"description": "overcast clouds",
"icon": "04d"
}
],
"base": "stations",
"main": {
"temp": 278.3,
"feels_like": 273.43,
"temp_min": 277.04,
"temp_max": 279.26,
"pressure": 1021,
"humidity": 69
},
"wind": {
"speed": 4.1,
"deg": 220
},
"clouds": {
"all": 100
},
"dt": 1578837080,
"sys": {
"type": 1,
"id": 1713,
"message": 0,
"country": "PL",
"sunrise": 1578811255,
"sunset": 1578840399
},
"timezone": 3600,
"id": 756135,
"name": "Warsaw",
"cod": 200
}
}
## TODOs and notes
* Redis communication/requests maybe could be improved (pipelining for Get operation?)
* Storage in Redis can be improved, for now values are stored as JSON). Maybe
more efficient approach can be chosen, e.g. storing as protobufs?
* For the API JSON REST was chosen as it wasn't specified wether to use Protobuf
or similar, based API.
* Only a very minimal set of tests (**a test**) has been provided (no mention of that
in task description and mocking/stubbing OpenWeather's API would increase the
effort and time to finish the task overall)
* Geting weather data from OpenWeather API is done in a single request for single
city manner. This could be improved by storing a city to city ID mapping in
some sort of key, value store but that would make the application more complex
(should it though?)