Skip to content

ReturDev/gym-exercises-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gym Exercises API 🏋️‍♂️ API

⚠️ Note: This API is hosted on a free service for testing purposes, which may lead to slower performance. Additionally, if the API has not been used for a while, the server may shut down, resulting in longer load times upon reactivation. Please allow between 3 and 5 minutes for the API to fully start up.

📜 Overview

The Gym Exercises API is a RESTful service designed to manage gym exercises and equipment. It provides endpoints for creating, updating, retrieving, and deleting exercises and equipment, along with their associated muscle engagements.

🌟 Features

  • User Authentication: Secure user login and authentication using Spring Security 🔐.
  • Exercise Management: CRUD operations for exercises, including name, description, and muscle engagement information 🏋️‍♀️.
  • Equipment Management: Manage gym equipment with options to add, update, and delete equipment 🛠️.
  • Pagination Support: Efficiently handle large datasets with pagination in the API responses 📊.
  • Error Handling: Comprehensive error handling with detailed error messages for invalid requests ❌.
  • Swagger Documentation: Interactive API documentation generated with Swagger for easy testing and exploration of the API endpoints 📄.

⚙️ Technologies Used

  • Java: The primary programming language for developing the API.
  • Spring Boot: Framework for building the RESTful API.
  • Spring Security: Authentication and authorization for secure access to the API.
  • Hibernate: ORM framework for database interactions.
  • MySQL: Database for storing exercises and equipment data.
  • Swagger: API documentation tool for providing an interactive API interface.

📈 Usage

You can test the API endpoints using the provided Swagger documentation. Access it here.

📄 License

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


Feel free to explore and enjoy managing your gym exercises! 💪