Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orliluq/trivia
🎃 Backend Challenge (Java): API para una trivia de Halloween! 🎃
https://github.com/orliluq/trivia
devtools h2-database jakarta java jpa-persistence-applications openapi springboot swagger-ui
Last synced: 23 days ago
JSON representation
🎃 Backend Challenge (Java): API para una trivia de Halloween! 🎃
- Host: GitHub
- URL: https://github.com/orliluq/trivia
- Owner: Orliluq
- License: mit
- Created: 2024-10-29T19:37:06.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-30T00:31:22.000Z (2 months ago)
- Last Synced: 2024-12-17T21:45:45.478Z (23 days ago)
- Topics: devtools, h2-database, jakarta, java, jpa-persistence-applications, openapi, springboot, swagger-ui
- Language: Java
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Backend Challenge (Java): 👻 Halloween Trivia API 👻
## 👻 **Theme:** Create an API for a Halloween trivia game!
## Description 🧛♂️
This project involves developing a RESTful API in Java that serves as a trivia game centered around Halloween. The API manages questions and answers related to myths and legends of Halloween.
## Requirements 🕸️
- Implement endpoints to:
- Add questions
- List all questions
- Update existing questions
- Questions must include a difficulty level (easy, medium, hard).
- Users should be able to retrieve a list of random questions for each difficulty level.
- Document the API using Swagger or OpenAPI.
## Endpoints ⚰️
Here are the available endpoints in the API:
1. **Add a New Question**
- **Endpoint:** `POST /questions`
- **Description:** Adds a new trivia question to the database.
- **Request Body:**
```json
{
"question": "What supernatural being is said to emerge from its grave on Halloween?",
"answer": "Zombie",
"difficulty": "hard"
}
```
2. **List All Questions**
- **Endpoint:** `GET /questions`
- **Description:** Retrieves all trivia questions from the database.
3. **Update an Existing Question**
- **Endpoint:** `PUT /questions/{id}`
- **Description:** Updates a trivia question by its ID.
- **Request Body:**
```json
{
"question": "What supernatural being is said to emerge from its grave on Halloween?",
"answer": "Zombie",
"difficulty": "medium"
}
```
4. **Get Random Questions by Difficulty**
- **Endpoint:** `GET /questions/random/{difficulty}`
- **Description:** Retrieves a list of random questions based on the specified difficulty level (easy, medium, hard).
## Technologies Used 🦇
- Java
- Spring Boot
- JPA (Java Persistence API)
- H2 Database (or any database of your choice)
- Swagger/OpenAPI for API documentation
## Setup Instructions 💀
1. Clone this repository:
```bash
`git clone https://github.com/Orliluq/trivia.git`
```
2. Navigate to the project directory:
```bash
`cd trivia`
```
3. Build the project:
```bash
`./mvnw clean install`
```
4. Run the application:
```bash
`./mvnw spring-boot:run`
```
5. Access the API documentation at:
```bash
`http://localhost:8080/swagger-ui.html`
```
## License 🎃
This project is licensed under the MIT License.
## Contributing 😱
Feel free to submit issues or pull requests if you want to contribute to this project!