https://github.com/ruben-rdez/openweathermap
An API to check the weather around the world
https://github.com/ruben-rdez/openweathermap
aws-eb ci-cd git github github-actions java lombok maven restapi springboot
Last synced: 2 months ago
JSON representation
An API to check the weather around the world
- Host: GitHub
- URL: https://github.com/ruben-rdez/openweathermap
- Owner: ruben-rdez
- Created: 2025-06-26T17:27:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-30T22:08:19.000Z (12 months ago)
- Last Synced: 2025-06-30T23:19:48.734Z (12 months ago)
- Topics: aws-eb, ci-cd, git, github, github-actions, java, lombok, maven, restapi, springboot
- Language: Java
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenWeatherMap API Spring Boot Application
This is a Spring Boot application that provides a RESTful API to fetch weather information using the OpenWeatherMap API.
## Features
- Fetch current weather data by city name
- RESTful API endpoints
- Spring Boot 3.5.3 implementation
- Easy configuration through application properties
## Prerequisites
- Java 17 or higher
- Maven 3.6 or higher
- OpenWeatherMap API key
## Configuration
1. Clone the repository
2. Update `src/main/resources/application.properties` with your OpenWeatherMap API key:
```properties
openweathermap.api.key=YOUR_API_KEY
```
## Building the Application
To build the application, run:
```bash
mvn clean install
```
## Running the Application
To start the application, run:
```bash
mvn spring-boot:run
```
The application will start on the default port 8080.
## API Endpoints
### Get Weather by City
```
GET /weather/{city}
```
Example:
```
GET /weather/London
```
Response:
```json
{
"weather information will be returned here"
}
```
## Project Structure
```
src/
├── main/
│ ├── java/
│ │ └── com/
│ │ └── openweathermap/
│ │ ├── controller/
│ │ │ └── WeatherController.java
│ │ ├── model/
│ │ │ └── WeatherResponse.java
│ │ ├── service/
│ │ │ └── WeatherService.java
│ │ └── OpenweathermapApplication.java
│ └── resources/
│ └── application.properties
└── test/
└── java/
└── com/
└── openweathermap/
└── OpenweathermapApplicationTests.java
```
## Technologies Used
- Spring Boot 3.5.3
- Spring Web
- Maven
- OpenWeatherMap API
## License
This project is available under the [insert license] license.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.