Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salma-4/quiz-api
A RESTful API for creating, managing, and taking quizzes. The API supports user authentication, quiz categorization, and various administrative functionalities.
https://github.com/salma-4/quiz-api
assertj dto-pattern java junit logging maven mockito mysql-database spring-boot spring-data-jpa spring-security-jwt swagger-ui unit-testing
Last synced: 11 days ago
JSON representation
A RESTful API for creating, managing, and taking quizzes. The API supports user authentication, quiz categorization, and various administrative functionalities.
- Host: GitHub
- URL: https://github.com/salma-4/quiz-api
- Owner: salma-4
- Created: 2024-11-05T22:16:11.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-12-11T22:53:03.000Z (2 months ago)
- Last Synced: 2025-02-02T02:28:17.145Z (11 days ago)
- Topics: assertj, dto-pattern, java, junit, logging, maven, mockito, mysql-database, spring-boot, spring-data-jpa, spring-security-jwt, swagger-ui, unit-testing
- Language: Java
- Homepage:
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **Quiz-API**
A RESTful API for creating, managing, and taking quizzes.
The API supports user authentication, quiz categorization, and various administrative functionalities.
---
## **Requirements**
- Java Development Kit (JDK) 17 or above
- MySQL Database [Customize yours](https://github.com/salma-4/Quiz-API/blob/master/src/main/resources/application.yml)
---
## **Features**
- User registration and authentication using JWT.
- CRUD operations for quizzes.
- Quiz categorization and search **TODO**.
- User and admin-specific operations **TODO**.
---
## **Endpoints**
### **1. User Authentication (Auth)**
Handles user registration, login, and other authentication-related actions.
| No. | Feature | Body | Header | Description | Endpoint |
|----:|---------------------|-----------------------------|-------------|----------------------------------------|------------------------------------------|
| 1. | Login | username(unique) , password | | generate new token for user | `POST quizApp/v1/auth/login ` |
| 2. | Register | Data of user | | Add new user create token | `POST quizApp/v1/auth/newUser ` |
| 3. | Logout | | Token | Logging out | `POST quizApp/v1/auth/logout ` |
| 4. | Forget password | | param/email | Send OTP to email | `POST /quizApp/v1/auth/user?email=` |
| 5. | Reset password | OTP ,new password | | Check OTP validity and update password | `POST quizApp/v1/auth/user/newPassword ` |
| 6. | Regenerate password | | param/email | regenerate OTP and send it | `POST quizApp/v1/auth/user/otp?email= ` |
### **2.Quiz Management**
Operations related to quizzes.
| No. | Feature | Body | Header | Description | Endpoint |
|----:|----------------|--------------------------------|--------|--------------------------------------------|--------------------------------------|
| 1. | Create quiz | Quiz data (category ,question) | Token | Create new Quiz to specified category | `POST quizApp/v1/quiz ` |
| 2. | All categories | | Token | Show all categories of quizzes exist | `GET quizApp/v1/quiz/allCategories ` |
| 3. | Quiz by cat. | | Token | Show list of quizzes to specified category | `GET quizApp/v1/quiz/{category} ` |
| 4. | Delete quiz | | Token | Delete quiz by its id | `GET quizApp/v1/quiz/{quizId} ` |
| 5. | Get quiz by id | | Token | | ` ` |
| 6. | Assign quiz | | Token | | ` ` |
| 7. | |
| 8. | |