https://github.com/rezairfanwijaya/go-exam-api
https://github.com/rezairfanwijaya/go-exam-api
echo-framework go mock mysql rest-api swagger
Last synced: 28 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rezairfanwijaya/go-exam-api
- Owner: rezairfanwijaya
- Created: 2022-11-29T03:16:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-04T06:32:09.000Z (over 2 years ago)
- Last Synced: 2025-02-14T18:18:03.409Z (3 months ago)
- Topics: echo-framework, go, mock, mysql, rest-api, swagger
- Language: Go
- Homepage:
- Size: 101 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Golang Exam RestApi App
Simple rest api to create questions and answer questions
## Run Locally
Clone the project
```bash
git clone https://github.com/rezairfanwijaya/go-exam-api.git
```
Go to the project directory
```bash
cd go-exam-api
```
#### Before running the project, first create a database using the MySQL DBMS, then setup env file in root project
Setup env
```bash
DATABASE_HOST = "your localhost host"
DATABASE_NAME = "your database name"
DATABASE_PORT = "your database port"
DATABASE_USERNAME = "your database username"
DATABASE_PASSWORD = "your database password"
KEY = "your secret key for JWT"
```
#### If the database does not have a password, leave it blank like this ```DATABASE_PASSWORD = ""```
Run migration table
```bash
go run main.go
```
result
#### after that
run migration up data user with your password database
```bash
migrate -database "mysql://yourdatabaseusername:yourdatabasepassword@tcp(yourdatabasehost:yourdatabaseport)/yourdatabasename" -path db/migration up
```
run migration up data user without your password database
```bash
migrate -database "mysql://yourdatabaseusername@tcp(yourdatabasehost:yourdatabaseport)/yourdatabasename" -path db/migration up
```
result
| email | password | role |
| :-------- | :------- | :------------------------- |
| [email protected] | 12345678 | siswa |
| [email protected] | 12345678 | siswa |
| [email protected] | 12345678 | siswa |
| [email protected] | 12345678 | siswa |
| [email protected] | 12345678 | guru |
## Endpoint
#### Login
```http
POST localhost:9090/login
```
| Body | Type | Description | Required |
| :-------- | :------- | :------------------------- | :------------------------- |
| `email` | `string` | email user | **Required** |
| `password` | `string` | password user with **len 8** | **Required** |
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses login"
},
"data": {
"id": 2,
"name": "siswa kedua",
"email": "[email protected]",
"role": "siswa",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ"
}
}
```
Response Failed
```bash
{
"meta": {
"status": "gagal",
"code": 400,
"message": "gagal melakukan login"
},
"data": "email tidak terdaftar"
}
```
#### Get User By JWT Token
```http
GET localhost:9090/v1/user/info
```
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses mengambil data user"
},
"data": {
"id": 2,
"email": "[email protected]",
"role": "siswa"
}
}
```
Response Failed
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "gagal melakukan authorization"
},
"data": "signature is invalid"
}
```
#### Create New Question (only teacher)
```http
POST localhost:9090/v1/question
```
| Payload | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `question` | `string` | Question | **Required**
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Payload Example
```bash
{
"question" : "berapakah kaki kucing"
}
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses menyimpan question"
},
"data": {
"id": 1,
"question" : "berapakah kaki kucing"
}
}
```
Response Failed
```bash
{
"meta": {
"status": "gagal validasi",
"code": 400,
"message": "gagal melakukan validasi"
},
"data": [
"error on filed: Question, condition: required"
]
}
```
Response Unauthorized (only teacher can create question)
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "akses ditolak"
}
```
```only can create one question in one request```
#### Get All Question
```http
GET localhost:9090/v1/questions
```
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses mengambil question"
},
"data": [
{
"id": 1,
"question": "1 + 1 ?"
},
{
"id": 2,
"question": "1 + 1 ?"
},
{
"id": 3,
"question": "1 + 1 ?"
},
{
"id": 4,
"question": "1 + 1 ?"
}
]
}
```
Response Unauthorized
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "Masukan string Bearer sebelum token"
}
```
#### Get Question By ID
```http
GET localhost:9090/v1/question/:id
```
| Param | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `id` | `integer` | Question ID | **Required**
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses mengambil question"
},
"data": {
"id": 1,
"number": 1,
"question": "Diamanakah ibu kota negara Brazil"
}
}
```
Response Failed
```bash
{
"meta": {
"status": "gagal",
"code": 400,
"message": "gagal mengambil question"
},
"data": "question dengan id 90 tidak ditemukan"
}
```
Response Unauthorized
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "Masukan string Bearer sebelum token"
}
```
#### Update Question (only teacher)
```http
PUT localhost:9090/v1/question/:id
```
| Payload | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `question` | `string` | Question | **Required**
| Param | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `id` | `int` | Question ID | **Required**
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Payload Example
```bash
{
"question" : "berapakah kaki macan"
}
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses mengupdate question"
},
"data": {
"id": 2,
"question": "2+2 berapa ?"
}
}
```
Response Failed
```bash
{
"meta": {
"status": "gagal",
"code": 400,
"message": "gagal mengupdate question"
},
"data": "question dengan id 90 tidak ditemukan"
}
```
Response Unauthorized (only teacher can update question)
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "akses ditolak"
}
```
```only can update one question in one request```
#### Delete Question (only teacher)
```http
DELETE localhost:9090/v1/question/:id
```
| Param | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `id` | `int` | Question ID | **Required**
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses menghapus soal"
},
"data": "soal berhasil dihapus"
}
```
Response Failed
```bash
{
"meta": {
"status": "gagal",
"code": 500,
"message": "gagal menghapus question"
},
"data": "question dengan id 99 tidak ditemukan"
}
```
Response Unauthorized (only teacher can delete question)
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "akses ditolak"
}
```
```only can delete one question in one request```
#### Save Answer
```http
POST localhost:9090/v1/answer
```
| Payload | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `answers` | `[]Answer` | Answers | **Required**
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Payload Example
```bash
{
"answers" : [
{
"question_id" : 1,
"answer" : "Indonesia"
},
{
"question_id" : 2,
"answer" : "Golang"
}
]
}
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses menyimpan jawaban"
},
"data": "sukses"
}
```
Response Failed
```bash
{
"meta": {
"status": "gagal",
"code": 400,
"message": "gagal submit jawaban"
},
"data": "question dengan id 1 sudah dijawab"
}
```
```bash
{
"meta": {
"status": "gagal",
"code": 400,
"message": "gagal submit jawaban"
},
"data": "question dengan id 90 tidak ditemukan"
}
```
Response Unauthorized (only student can save answers)
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "akses ditolak"
}
```
```students can only answer 1 question with 1 answer, not multiple on the same question```
#### Get Answer By Student ID
```http
GET localhost:9090/v1/answer
```
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses mengambil jawaban"
},
"data": [
{
"id": 1,
"answer": "Golang",
"question_id": 5,
"user_id": 1
},
{
"id": 2,
"answer": "Ruby",
"question_id": 2,
"user_id": 1
}
]
}
```
Response Unauthorized
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "akses ditolak, hanya siswa yang diperbolehkan"
}
```
#### Get All Answer (only teacher)
```http
GET localhost:9090/v1/answers
```
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses mengambil semua jawaban"
},
"data": [
{
"id": 4,
"answer": "Golang",
"question_id": 2,
"user_id": 2
},
{
"id": 5,
"answer": "Javascript",
"question_id": 3,
"user_id": 2
},
{
"id": 6,
"answer": "Ruby",
"question_id": 1,
"user_id": 2
},
{
"id": 7,
"answer": "Python",
"question_id": 4,
"user_id": 2
},
{
"id": 8,
"answer": "ReactJS",
"question_id": 5,
"user_id": 1
},
{
"id": 9,
"answer": "GIN",
"question_id": 2,
"user_id": 1
}
]
}
```
Response Unauthorized (only teacher can get all answers from student)
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "akses ditolak, hanya guru yang diperbolehkan"
}
```
#### Update Question
```http
PUT localhost:9090/v1/answer
```
| Payload | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `answers` | `[]Answer` | Answers | **Required**
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Payload Example
```bash
{
"answers" : [
{
"question_id" : 1,
"answer" : "Ruby on Rails"
},
{
"question_id" : 2,
"answer" : "Golang"
}
]
}
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses mengupdate jawaban"
},
"data": "sukses mengupdate jawaban"
}
```
Response Failed
```bash
{
"meta": {
"status": "gagal",
"code": 400,
"message": "gagal mengupate jawaban"
},
"data": "anda belum menjawab pertanyaan dengan id 4"
}
```
Response Unauthorized (only student can update answers)
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "akses ditolak, hanya siswa yang diperbolehkan"
}
```
#### Delete Answer By Question ID
```http
DELETE localhost:9090/v1/answer/:id
```
| Param | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `id` | `integer` | Question ID | **Required**
| Header | Type | Description | Required |
| :-------- | :------- | :-------------------------------- | :-------------------------------- |
| `Authorization` | `string` | Set yuor header with value token when you get on login | **Required**
```bash
Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNpc3dha2VkdWFAZ21haWwuY29tIiwiZXhwaXJlZCI6MTY2OTk1MTQ1NiwidXNlcklEIjoyfQ.2DJa8GBpxWrYcgVUwoha6rNQmGZGHc7zv9njxPxdDbQ
```
Response Success
```bash
{
"meta": {
"status": "sukses",
"code": 200,
"message": "sukses menghapus jawaban"
},
"data": "sukses menghapus jawaban"
}
```
Response Unauthorized (only student can delete their answer)
```bash
{
"meta": {
"status": "Unauthorized",
"code": 401,
"message": "error"
},
"data": "akses ditolak, hanya siswa yang diperbolehkan"
}
```
```only can delete one answer in one request```