- Back-end framework providing data to the Omni app
- Link to live server: https://murmuring-ridge-04034.herokuapp.com
- User Endpoint
- Login Endpoint
- Question Endpoint
- Answer Endpoint
- Answer Upvotes Endpoint
- Question Likes Endpoint
- Department Endpoint
**insert later **
Creates new user accounts in the database. This requires a JSON Object with name, username, and password (must contain minimum 8 characters with at least 1 uppercase, 1 lowercase, and 1 number)
Response: 201 CREATED
{
"name": "Username",
"username": "Testuser",
"password": "ASDFasdf12!@"
}
Gets a users name from the database.
Response: 200 OK
{
"name": "Username"
}
Facilitates logging in by the client. This requires a JSON object with username and password in the request body.
Response: 200 OK
{
"username": "Testuser",
"password": "ASDFasdf12!@"
}
{
"authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoyLCJpYXQiOjE1OTA3NzY1MDUsInN1YiI6ImZpcnN0dHJ5In0.pH3KEein7GZWotxhHK-1gq4GlID7EGY9o3301uhEL2k"
}
Returns an array of all questions from the database.
Response: 200 OK
[
{
"id": 1,
"author": 1,
"question_body": "test question 1",
"department": 1,
"created_date": "2020-05-29T18:39:07.526Z",
"answered": false
},
{
"id": 2,
"author": 1,
"question_body": "test question 2",
"department": 2,
"created_date": "2020-05-29T18:39:07.526Z",
"answered": false
},
]
Creates a question in the database. This requires an Authorization header with a Bearer token (received from POST /api/auth/login), as well as a JSON object with question_body(string) and department_id(int) in the request body.
Response: 201 Created
{
"question_body": "test question 10",
"department_id": 1
}
Example response body from POST
{
"id": 1,
"author": 1,
"question_body": "test question 10",
"department": 1,
"created_date": "2020-05-29T18:39:07.526Z",
"answered": false
}
Deletes a question by the user matched using the token. This requires an Authorization header with a Bearer Token (received from POST /api/auth/login)
Response: 204 NO CONTENT
Updates a question by the user matched using the token. This requires an Authorization header with a Bearer Token (received from POST /api/auth/login), as well as a JSON object with at least one of the following optional fields: question_body(string), department_id(int), and answered(boolean) in the request body.
Response: 200 OK
Example request from the client
{
"question_body": "update_question_2",
"department_id": 3,
"answered": true
}
Example response from the database
{
"id": 2,
"author": 1,
"question_body": "update_question_2",
"department": 2,
"created_date": "2020-06-03T21:01:50.870Z",
"answered": true
}
Returns an array of all answers from the database.
Response: 200 OK
Example response from database.
[
{
"id": 1,
"author": 2,
"question": 1,
"answer_body": "test answer 10",
"created_date": "2020-05-29T20:16:12.670Z"
},
{
"id": 2,
"author": 2,
"question": 2,
"answer_body": "test answer 11",
"created_date": "2020-05-29T20:16:12.670Z"
}
]
Creates an answer in the database. This requires an Authorization header with a Bearer token (received from POST /api/auth/login), as well as a JSON object with answer_body(string) and question_id(int) in the request body.
Example request body from client
{
"answer_body": "test answer 3",
"question_id": 5
}
Example response body from POST
{
"id": 3,
"author": 2,
"question": 5,
"answer_body": "test answer 3",
"created_date": "2020-05-29T19:38:06.924Z"
}
Deletes a answer by the user matched using the token. This requires an Authorization header with a Bearer Token (received from POST /api/auth/login)
Response: 204 NO CONTENT
Updates an answer by the user matched using the token. This requires an Authorization header with a Bearer Token (received from POST /api/auth/login), as well as a JSON object with answer_body (string).
Response: 200 OK
Example request from the client
{
"answer_body": "updated-answer-2",
}
Example response from the database
{
"id": 2,
"author": 2,
"question": 2,
"answer_body": "updated-answer-2",
"created_date": "2020-06-04T20:27:43.390Z"
}
Gets the total upvote count for a given answer (req.params.answer_id). This requires an Authorization header with a Bearer Token (received from POST /api/auth/login).
Response: 200 OK
Example response from database.
[
{
"count": "1"
}
]
Increases the total upvote count for a given answer (req.params.answer_id). This requires an Authorization header with a Bearer Token (received from POST /api/auth/login).
Response: 204 NO CONTENT
Gets a list of all the question ids the currently logged in user has liked. This requires an Authorization header with a Bearer Token (received from POST /api/auth/login).
Response: 200 OK
Example response from database.
[
{
"question_id": 3
},
{
"question_id": 4
},
{
"question_id": 5
}
]
Gets the total number of likes for a question (req.params.question_id). This requires an Authorization header with a Bearer Token (received from POST /api/auth/login).
Response: 200 OK
Example response from database.
[
{
"count": "1"
}
]
Increases the like upvote count for a given question (req.params.question_id). This requires an Authorization header with a Bearer Token (received from POST /api/auth/login).
Response: 204 NO CONTENT
Gets the department name for a given department_id (req.params.department_id). This requires an Authorization header with a Bearer Token (received from POST /api/auth/login).
Response: 200 OK
{
"department_name": {
"name": "Sales"
}
}