Kalle's Weather Dashboard API 🌤
API that consumes the DMI API and presents weather data through different endpoints.
🌐 Hosting
App is hosted on api.weather.kols.dk.
SSL are managed through Google Cloud Platform.
Redish cache is hosted here: https://app.redislabs.com/#/subscriptions/subscription/1838338/bdb-view/11200786/configuration
🏗 Setup
This app uses env variables to get API keys. The following keys are needed:
| Variable | Description | Status |
|---|---|---|
| DMI_MET_OBS_API_KEY | Key to access to weather observation API | Required |
| DMI_OCEAN_OBS_API_KEY | Key to access to ocean observartion API | Required |
| REDIS_URL | URL endpoint for the Redis Cache | Required |
| REDIS_DB_PSWD | The password the the Redis Cache database | Required |
| PORT | The port that the app is exposed through on the host machine | Optional |
During development, API keys should be stored as env variables on the OS. When deploying to production, proper API keys are injected in pkg/common/envs/config.yaml from a GitHub Action. API keys are found on the DMI Open Data platform.
Run the application
Run the commands go run cmd/main.go
♻️ Deployment
The project is deployed to the kalles-weather-dashboard-api-project on Google Cloud Platform.
The application is deployed to GCP on every push to main. It is not possible to deploy through the gcloud CLI, due to API key injection in deployment process.
📚 Documentation
API endpoint documentation
Using Swagger (gin-swagger) to give endpoint overview. Navigate to /swagger/index.html to browse. Run swag init -g cmd/main.go to update docs.
Swagger doc strings has to be created on each endpoint. See https://github.com/swaggo/swag/blob/master/README.md#api-operation for more info.
Data caching
For the weather observations, a Redis cache is setup to limit the interaction with the DMI API. The key format is YYYY-M-D-min|max, for the minimum or maximum temperature for a given date. When fetching data, the cache is checked first, then DMI API if there is no matching key.
🔗 Dependecies
| Package | Description | Link |
|---|---|---|
| github.com/gin-gonic/gin | HTTP web framework | https://github.com/gin-gonic/gin |
| github.com/gin-contrib/cors | Manage CORS | https://github.com/gin-contrib/cors |
| github.com/spf13/viper | Managing of configuration | https://github.com/spf13/viper |
| github.com/swaggo/swag | API documentation with Swagger | https://github.com/swaggo/swag |
| github.com/go-redis/redis | Client for interactiong with Redis cache | https://github.com/go-redis/redis |