https://github.com/nath-green/quizzee-api
General knowledge quiz questions API
https://github.com/nath-green/quizzee-api
api express javascript nodejs
Last synced: 2 months ago
JSON representation
General knowledge quiz questions API
- Host: GitHub
- URL: https://github.com/nath-green/quizzee-api
- Owner: nath-green
- Created: 2019-01-28T14:07:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-30T11:21:34.000Z (over 6 years ago)
- Last Synced: 2025-01-31T23:31:38.186Z (4 months ago)
- Topics: api, express, javascript, nodejs
- Language: JavaScript
- Size: 74.2 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quizzee API
📖 A simple RESTful API for the general knowledge quiz questions.
📑 The current version of the API lives at `https://quizzee-api.herokuapp.com/api/v1`
⚡ API last updated on: `30/01/2018`
---
### _question_ resource
📥 `https://quizzee-api.herokuapp.com/api/v1/question`
| # | Method | Endpoint | Description | Param |
| ---------------------------------------------------------------- | ------- | -------------------- | --------------------------------------- | ------------------- |
| [1](#user-content-1---get-retrieve-random-questions) | `[GET]` | /question | Retrieve random question(s) | `number` (optional) |
| [2](#user-content-2---get-retrieve-random-questions-by-category) | `[GET]` | /question/{category} | Retrieve random question(s) by category | `number` (optional) |
If `number` param is excluded, **one** random question will be returned. The endpoints only take this parameter and should be passed an integer.
---
#### ⭐ `Question` object:
| Key | Type |
| ------------- | ------ |
| \_id | String |
| question | String |
| answers | Object |
| answers[a] | String |
| answers[b] | String |
| answers[c] | String |
| answers[d] | String |
| correctAnswer | String |
| category | String |
---
#### Endpoint responses:
| Key | Type | on Success | on Fail |
| ------- | -------------------------------------------------- | ---------- | ------- |
| data | Array (of [`Question`](#-question-object) objects) | Y | N |
| message | String | N | Y |
---
#### Categories:
| Category | Name |
| ----------------- | --------- |
| General knowledge | `general` |
| Music | `music` |
| Sport | `sport` |
---
#### 1 - `[GET]` Retrieve random question(s)
📥 `https://quizzee-api.herokuapp.com/api/v1/question{?number=X}`
> Return a number of random questions from all categories
##### ✅ Example success response:
> status: `200`
```json
{
"data": [
{
"_id": "5c5070e6e7179a1e4684b061",
"question": "What is Rihanna's real first name?",
"answers": {
"a": "Rihanna",
"b": "Robyn",
"c": "Aliah",
"d": "Susan"
},
"correctAnswer": "b",
"category": "music"
}
]
}
```
##### 🔴 Example error response:
> status: `400`
```json
{
"message": "Cannot return question(s)"
}
```
---
#### 2 - `[GET]` Retrieve random question(s) by category
📥 `https://quizzee-api.herokuapp.com/api/v1/question/{category}{?number=X}`
> Return a number of random questions from a [specific category](#user-content-categories)
##### ✅ Example success response:
> status: `200`
```json
{
"data": [
{
"_id": "5c518452e7179a1e468573e1",
"question": "How many players are actively playing in a basketbal team?",
"answers": {
"a": "4",
"b": "6",
"c": "5",
"d": "7"
},
"correctAnswer": "c",
"category": "sport"
},
{
"_id": "5c51848fe7179a1e46857405",
"question": "What year did the new Wembley stadium open?",
"answers": {
"a": "2007",
"b": "2008",
"c": "2004",
"d": "2005"
},
"correctAnswer": "a",
"category": "sport"
}
]
}
```
##### 🔴 Example error response:
> status: `400`
```json
{
"message": "Cannot return question(s)"
}
```