Weather Mock API

A simple weather mock API implemented in Rust using Actix Web. This API returns a static list of weather forecasts for a given location.

Table of Contents

• Weather Mock API
  • Table of Contents
  • Features
  • Requirements
  • Installation
  • Usage
  • Docker
    • Build and Run with Docker
    • Stop and Remove the Docker Container
  • Contributing
  • License
  • Support and Issues
  • Acknowledgments

Features

• Actix Web framework for building the API
• Tracing for logging and instrumentation
• Serde for serialization and deserialization
• Docker support for easy deployment

Requirements

• Rust 1.54 or higher
• Docker (optional, for deployment)

Installation

1. Clone the repository:

   git clone https://github.com/aortizpimentel/weather-mock-api.git
   cd weather-mock-api

2. Build the project:

   cargo build --release

Usage

1. Run the application:

   cargo run --release

2. Access the API: The API will be available at http://localhost:8080/forecasts?lat={latitude}&lon={longitude}. Replace {latitude} and {longitude} with the desired coordinates.

Docker

Build and Run with Docker

1. Build the Docker image:

   docker build -t weather-mock-api .

2. Run the Docker container:

   docker run -p 8080:8080 --name weather-api weather-mock-api

3. Access the API:

   The API will be available at http://localhost:8080/forecasts?lat={latitude}&lon={longitude}. Replace {latitude} and {longitude} with the desired coordinates.

Stop and Remove the Docker Container

1. Stop the Docker container:

   docker stop weather-api

2. Remove the Docker container:

   docker rm weather-api

Contributing

1. Fork the repository on GitHub
2. Create a new branch for your changes
3. Commit your changes to the new branch
4. Submit a pull request to merge your changes into the main repository

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support and Issues

If you encounter any issues or need help, please open a new GitHub issue in this repository.

Acknowledgments

• The Rust programming language for its safety and performance features
• The Actix Web framework for its extensible and easy-to-use API
• The Serde library for its powerful serialization and deserialization capabilities
• The tracing crate for its excellent logging and instrumentation tools

Happy coding! 🚀