Reservamos REST API

API that provides the weather forecast for the following days of a given city.

This API connects to Reservamos service to find the coordinates of a place and returns the weather information using OpenWeather's API.

Built With

• Ruby on Rails

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Docker Desktop
• Copy of the project on your local computer

Installation

Navigate to the application directory and execute: docker compose up

Documentation

The documentation is in the following Postman Collection.

Features

• Encrypted credentials
• Logging of request exceptions
• Easy integration of new services to get locations and weather forecast
• Handling service interruptions of third-party services
• API versioning
• Tests
• Linter (RuboCop)
• Env variables

Roadmap

• Implement cache
• Return the weather forecast of top cities by default
• Include optional parameters to modify temperature units and max number of days for weather forecast
• Rate limiting requests per IP address