Udacity is invested in creating bonding experiences for its employees and students. A bunch of team members got the idea to hold trivia on a regular basis and created a webpage to manage the trivia app and play the game, but their API experience is limited and still needs to be built out.
That where you come in! Help them finish the trivia app so they can start holding trivia and seeing who's the most knowledgeable of the bunch. The application must:
- Display questions - both all questions and by category. Questions should show the question, category and difficulty rating by default and can show/hide the answer.
- Delete questions.
- Add questions and require that they include question and answer text.
- Search for questions based on a text query string.
- Play the quiz game, randomizing either all questions or within a specific category.
Completing this trivia app will give you the ability to structure plan, implement, and test an API - skills essential for enabling your future applications to communicate with others.
There are TODO comments throughout project. Start by reading the READMEs in:
We recommend following the instructions in those files in order. This order will look familiar from our prior work in the course.
https://documenter.getpostman.com/view/5081938/SzS1TonS
Click here
Currently,
| HTTP VERB | ENDPOINT | TASK |
| POST | api/categories/ | Create A Question category |
| GET | api/categories/ | Return ArrayList of Question Categories |
| POST | api/questions/ | Create A Question |
| GET | api/questions?page=1 | Return an array list of questions with pages |
| DELETE | api/questions/{question_id} | Delete question with the stated ID |
| GET | api/questions/{question_id} | Get a specific question details base on ID |
| GET | api/categories/{category_id}/questions | Get set of question in a category base on Category ID |
| POST | api/questions/search | Get set of questions base on search term |
| POST | api/play_quizzes | Return Specific question at Random base on category and previous question |
GET '/api/categories'
- Fetches a dictionary of categories in which the keys are the ids and the value is the corresponding string of the category
- Request Arguments:
None - Returns: An object with a single key, categories, that contains a object of id: category_string key:value pairs.
{'1' : "Science",
'2' : "Art",
'3' : "Geography",
'4' : "History",
'5' : "Entertainment",
'6' : "Sports"}
POST '/api/categories'
- Create new categories for questions to be added.
- Request Arguments:
{ "type":"Biochemistrys" } - Response: An object of categories updated
{
"categories": [
{
"id": 1,
"type": "Science"
},
{
"id": 2,
"type": "Art"
},
{
"id": 3,
"type": "Geography"
},
{
"id": 23,
"type": "Biochemistrys"
}
],
"category created": "Biochemistrys",
"created": 23,
"success": true,
"total_categories": 23
}
POST /api/questions
- Add questions to already created category.
- Request Arguments:
{
"question": "Who discovered penicillin?",
"answer":"Alexander Fleming",
"difficulty":3,
"category":1,
"id":8
}
- Response: Returns objects of existing questions with created id.
{
"created": 33,
"questions": [
{
"answer": "Apollo 13",
"category": 5,
"difficulty": 4,
"id": 2,
"question": "What movie earned Tom Hanks his third straight Oscar nomination, in 1996?"
},
{
"answer": "Tom Cruise",
"category": 5,
"difficulty": 4,
"id": 4,
"question": "What actor did author Anne Rice first denounce, then praise in the role of her beloved Lestat?"
}
],
"success": true,
"total_questions": 22
}
POST 'api/questions/search'
- Search questions database base on text argument supplied
- Request Arguments:
{
"search":"title"
}
- Response: Return objects of questions matching the search parameters.
{
"questions": [
{
"answer": "Maya Angelou",
"category": 4,
"difficulty": 2,
"id": 5,
"question": "Whose autobiography is entitled 'I Know Why the Caged Bird Sings'?"
},
{
"answer": "Edward Scissorhands",
"category": 5,
"difficulty": 3,
"id": 6,
"question": "What was the title of the 1990 fantasy directed by Tim Burton about a young man with multi-bladed appendages?"
}
],
"success": true,
"total_questions": 2
}
POST '/api/play_quizzes'
- Generate random questions base category and previous question.
- Request Arguments:
{
"quiz_category":{
"id":1
},
"previous_questions":[1,2]
}
- Response: Returns an object containing questions, answers and category_id
{
"question": {
"answer": "The Liver",
"category": 1,
"difficulty": 4,
"id": 20,
"question": "What is the heaviest organ in the human body?"
},
"success": true
}
Fork the project repository and Clone your forked repository to your machine. Work on the project locally and make sure to push all your changes to the remote repository before submitting the link to your repository in the Classroom.
We started the full stack application for you. It is desiged with some key functional areas:
The ./backend directory contains a partially completed Flask and SQLAlchemy server. You will work primarily in app.py to define your endpoints and can reference models.py for DB and SQLAlchemy setup.
The ./frontend directory contains a complete React frontend to consume the data from the Flask server. You will need to update the endpoints after you define them in the backend. Those areas are marked with TODO and can be searched for expediency.
Pay special attention to what data the frontend is expecting from each API response to help guide how you format your API.