This project is a Hangman game API built with Spring Boot. It allows users to register, login, play the Hangman game, and perform various user-related operations.
To run this project, you need:
- Java Development Kit (JDK) 8 or higher
- Apache Maven
- MySQL Server
- Postman (for testing APIs)
- Clone this repository to your local machine.
- Set up a MySQL database and configure the database connection properties in
application.properties. - Run the application using Maven
- Once the application is running, you can access the API documentation in the OpenAPI format from
resources/static/openapi.yaml.
All the API endpoints along with their request and response schemas are documented in the OpenAPI specification file resources/static/openapi.yaml. You can use tools like Swagger UI or Postman to visualize and test the APIs.
To use Postman:
- Import the OpenAPI specification file into Postman.
- You can explore and run each API endpoint directly from Postman.
- Make sure to provide the necessary request parameters and headers as described in the API documentation.
- Simple user account creation with username and password. User credentials are securely stored using bcrypt encryption.
- Login functionality to authenticate users.
- Ability to play the Hangman game.
- User profile management including updating email and resetting password.
- Role-based access control with user and admin roles.
- All API endpoints are documented in the OpenAPI specification file.
- Implement broadcasting to all players in a room for real-time updates.
- Enhance user experience with additional game features and functionalities.