Qiao Yingjie
1004514
Using FastAPI and PostgreSQL. This implements a student - course system where each course could enroll multiple students, but a student can have at most 1 course. (see a command-line illustration of the one-to-many relationship here), and a gallery to showcase some beautiful images.
There are 3 tables in the database and all 3 do not allow duplicated rows.
Run the API server and database service with containers locally.
-
run the following to start the containers:
docker-compose build docker-compose up
Wait until both
dbandrest_apiare up and running,db_1 | 2021-10-06 13:23:38.591 UTC [47] LOG: database system was shut down at 2021-10-06 13:23:38 UTC db_1 | 2021-10-06 13:23:38.604 UTC [1] LOG: database system is ready to accept connections rest_api_1 | INFO: Started server process [1] rest_api_1 | INFO: Waiting for application startup. rest_api_1 | INFO: Application startup complete. rest_api_1 | INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
then proceed to then next step to go into the container.
-
Find the container IDs
After the containers are up, run
docker container lsto find the container with the namenetworks_lab2_rest_api_1and the container with the namenetworks_lab2_db_1. Note down their container IDs. -
Access the terminal of the API server container
With the <rest_api_container_id> of the API server, run the following to go to the API server's terminal:
docker exec -it <rest_api_container_id> bash
After going into the terminal for the API server container, run the following to populate the database:
python init_test.py
-
Access the terminal of the database container
With the <db_container_id> of the database service, run the following to go to the terminal for the database container:
docker exec -it <db_container_id> bash
After going into the terminal for the database container, run the following to go to PostgreSQL command line:
psql -U postgres
Now, after you have run
python init_test.pyin Step 3 to populate the database tables, you should be able to see the table names and inital values in tablecourseand tablestudent:bash-5.1# psql -U postgres psql (13.4) Type "help" for help. postgres=# \dt List of relations Schema | Name | Type | Owner --------+---------+-------+---------- public | course | table | postgres public | file | table | postgres public | student | table | postgres (3 rows) postgres=# SELECT * FROM course; id | title | description ----+------------------------+------------------------------- 1 | Intro to Algo | leetcode 2 | Digital World | use jupyter notebook 3 | Computation Structures | most difficult module in ISTD postgres=# SELECT * FROM student; id | name | email | gpa | course_id ----+------------------+----------------------------+-----+----------- 1 | Walter White | walter_white@sutd.edu | 5.3 | 2 | Jesse Pinkman | jess_pinkman@sutd.edu | 0.5 | 3 | Gus String | gus_string@sutd.edu | 4.5 | 4 | Hank Schrader | hank_schrader@sutd.edu | 4.5 | 5 | Stannis Bar | stannis_bar@sutd.edu | 2.5 | 6 | Jon Snow | jon_snow@sutd.edu | 2 | 7 | Tyrion Lannister | tyrion_lanniester@sutd.edu | 5 | 8 | Cersei Lannister | cersei_lannister@sutd.edu | 1 | (8 rows) postgres=#
when you terminate the containers, run
docker-compose down --volumes- A REST-over-HTTP API written in any programming language, in any framework, to imitate any real life service (e.g. fake myportal, fake edimension), backed with any other supporting services (redis, mysql, etc):
- Can be deployed on any docker host using
docker-compose- you fail if I need to install any other dependencies on my computer!- see the Setup section above.
- In short, run
docker-compose upat project root folder, and then attach to the FastAPI container.
- Can be deployed on any docker host using
IMPORTANT:
Please run python init_test.py to populate the tables with some initial rows as shown in
the Setup section above, so that the GET endpoints could work.
Running the tests with pytest testfile.py::test_function -s, with -s to capture stdout in terminal. All pytest
commands should be run in the rest_api container and the commands that check the database tables should be run in the
db container.
With accompanying pytest unit test files, showcasing your API's ability to respond to:
-
a GET request ...
-
with no query parameters
-
GET
/courseand GET/student -
make the request:
pytest tests/test_get.py::test_get_student_all -s
-
expected stdout:
collected 1 item tests/test_get.py [{"name":"Walter White","email":"walter_white@sutd.edu","gpa":5.3,"id":1,"course_id":null},{"name":"Jesse Pinkman","email":"jess_pinkman@sutd.edu","gpa":0.5,"id":2,"course_id":null},{"name":"Gus String","email":"gus_string@sutd.edu","gpa":4.5,"id":3,"course_id":null},{"name":"Hank Schrader","email":"hank_schrader@sutd.edu","gpa":4.5,"id":4,"course_id":null},{"name":"Stannis Bar","email":"stannis_bar@sutd.edu","gpa":2.5,"id":5,"course_id":null},{"name":"Jon Snow","email":"jon_snow@sutd.edu","gpa":2.0,"id":6,"course_id":null},{"name":"Tyrion Lannister","email":"tyrion_lanniester@sutd.edu","gpa":5.0,"id":7,"course_id":null},{"name":"Cersei Lannister","email":"cersei_lannister@sutd.edu","gpa":1.0,"id":8,"course_id":null}] -
make the request:
pytest tests/test_get.py::test_get_course_all -s
-
expected stdout:
collected 1 item tests/test_get.py [{"title":"Intro to Algo","description":"leetcode","id":1,"enrolled_students":[]},{"title":"Digital World","description":"use jupyter notebook","id":2,"enrolled_students":[]},{"title":"Computation Structures","description":"most difficult module in ISTD","id":3,"enrolled_students":[]}]
-
-
with a
sortByquery parameter, to transform the order of the items returned- GET
/student?sort_by=gpa- sort the students by GPA in ascending order - make the request:
pytest tests/test_get.py::test_get_student_sort_by -s
- expected stdout:
collected 1 item tests/test_get.py [{"name":"Jesse Pinkman","email":"jess_pinkman@sutd.edu","gpa":0.5,"id":2,"course_id":null},{"name":"Cersei Lannister","email":"cersei_lannister@sutd.edu","gpa":1.0,"id":8,"course_id":null},{"name":"Jon Snow","email":"jon_snow@sutd.edu","gpa":2.0,"id":6,"course_id":null},{"name":"Stannis Bar","email":"stannis_bar@sutd.edu","gpa":2.5,"id":5,"course_id":null},{"name":"Hank Schrader","email":"hank_schrader@sutd.edu","gpa":4.5,"id":4,"course_id":null},{"name":"Gus String","email":"gus_string@sutd.edu","gpa":4.5,"id":3,"course_id":null},{"name":"Tyrion Lannister","email":"tyrion_lanniester@sutd.edu","gpa":5.0,"id":7,"course_id":null},{"name":"Walter White","email":"walter_white@sutd.edu","gpa":5.3,"id":1,"course_id":null}]
- GET
-
with a
countquery parameter, to limit the number of items returned- GET
/student?count=3- return first 3 student rows in the table - make the request:
pytest tests/test_get.py::test_get_student_count -s
- expected stdout:
collected 1 item tests/test_get.py [{"name":"Walter White","email":"walter_white@sutd.edu","gpa":5.3,"id":1,"course_id":null},{"name":"Jesse Pinkman","email":"jess_pinkman@sutd.edu","gpa":0.5,"id":2,"course_id":null},{"name":"Gus String","email":"gus_string@sutd.edu","gpa":4.5,"id":3,"course_id":null}]
- GET
-
with a
offsetquery parameter, to "skip" ahead by a number of items- GET
/student?offset=3- skip first 3 - make the request:
pytest tests/test_get.py::test_get_student_offset -s
- expected stdout:
collected 1 item tests/test_get.py [{"name":"Hank Schrader","email":"hank_schrader@sutd.edu","gpa":4.5,"id":4,"course_id":null},{"name":"Stannis Bar","email":"stannis_bar@sutd.edu","gpa":2.5,"id":5,"course_id":null},{"name":"Jon Snow","email":"jon_snow@sutd.edu","gpa":2.0,"id":6,"course_id":null},{"name":"Tyrion Lannister","email":"tyrion_lanniester@sutd.edu","gpa":5.0,"id":7,"course_id":null},{"name":"Cersei Lannister","email":"cersei_lannister@sutd.edu","gpa":1.0,"id":8,"course_id":null}]
- GET
-
with any combination of the above query parameters
- GET
/student?sort_by=gpa&count=5 - make the request:
pytest tests/test_get.py::test_get_student_limit_sort_by -s
- expected stdout:
collected 1 item tests/test_get.py [{"name":"Jesse Pinkman","email":"jess_pinkman@sutd.edu","gpa":0.5,"id":2,"course_id":null},{"name":"Cersei Lannister","email":"cersei_lannister@sutd.edu","gpa":1.0,"id":8,"course_id":null},{"name":"Jon Snow","email":"jon_snow@sutd.edu","gpa":2.0,"id":6,"course_id":null},{"name":"Stannis Bar","email":"stannis_bar@sutd.edu","gpa":2.5,"id":5,"course_id":null},{"name":"Hank Schrader","email":"hank_schrader@sutd.edu","gpa":4.5,"id":4,"course_id":null}]
- GET
-
-
a POST request ...
-
that creates a new resource with the given attributes in the body
- POST
/course, POST/student - make valid requests: - add student
Samwell Tarlyand courseDiscrete Mathto the tablespytest tests/test_create.py::test_create_student_success -s pytest tests/test_create.py::test_create_course_success -s
- expected stdout:
collected 1 item tests/test_create.py {"name":"Samwell Tarly","email":"samwell_tarly@sutd.edu","gpa":5.0,"id":9,"course_id":null} collected 1 item tests/test_create.py {"title":"Discrete Math","description":"sutd doesnt teach","id":4,"enrolled_students":[]} - check the database tables - you can see new rows added:
postgres=# SELECT * FROM course; id | title | description ----+------------------------+------------------------------- 1 | Intro to Algo | leetcode 2 | Digital World | use jupyter notebook 3 | Computation Structures | most difficult module in ISTD 4 | Discrete Math | sutd doesnt teach (4 rows) postgres=# SELECT * FROM student; id | name | email | gpa | course_id ----+------------------+----------------------------+-----+----------- 1 | Walter White | walter_white@sutd.edu | 5.3 | 2 | Jesse Pinkman | jess_pinkman@sutd.edu | 0.5 | 3 | Gus String | gus_string@sutd.edu | 4.5 | 4 | Hank Schrader | hank_schrader@sutd.edu | 4.5 | 5 | Stannis Bar | stannis_bar@sutd.edu | 2.5 | 6 | Jon Snow | jon_snow@sutd.edu | 2 | 7 | Tyrion Lannister | tyrion_lanniester@sutd.edu | 5 | 8 | Cersei Lannister | cersei_lannister@sutd.edu | 1 | 9 | Samwell Tarly | samwell_tarly@sutd.edu | 5 | (9 rows) postgres=#
- POST
-
show that the resource has indeed been created through another HTTP request
-
GET
/course/{course_name}and GET/student/{student_name} -
make the requests: GET
/course/Discrete%20Mathand GET/student/Samwell%20Tarlypytest tests/test_get.py::test_get_course_by_name -s pytest tests/test_get.py::test_get_student_by_name -s
-
expected stdout:
collected 1 item {"title":"Discrete Math","description":"sutd doesnt teach","id":4,"enrolled_students":[]} collected 1 item tests/test_get.py {"name":"Samwell Tarly","email":"samwell_tarly@sutd.edu","gpa":5.0,"id":9,"course_id":null}
-
-
has validation and returns an appropriate HTTP response code if the input data is invalid (e.g. missing name)
- invalid requests: row already exists. Try insert the same
Studentinto table:pytest tests/test_create.py::test_create_student_fail_1 -s
- expected stdout:
collected 1 item tests/test_create.py {"detail":"This student has already been created."} - check the table
studentand no duplicated row is added:postgres=# SELECT * FROM student; id | name | email | gpa | course_id ----+------------------+----------------------------+-----+----------- 1 | Walter White | walter_white@sutd.edu | 5.3 | 2 | Jesse Pinkman | jess_pinkman@sutd.edu | 0.5 | 3 | Gus String | gus_string@sutd.edu | 4.5 | 4 | Hank Schrader | hank_schrader@sutd.edu | 4.5 | 5 | Stannis Bar | stannis_bar@sutd.edu | 2.5 | 6 | Jon Snow | jon_snow@sutd.edu | 2 | 7 | Tyrion Lannister | tyrion_lanniester@sutd.edu | 5 | 8 | Cersei Lannister | cersei_lannister@sutd.edu | 1 | 9 | Samwell Tarly | samwell_tarly@sutd.edu | 5 | (9 rows)
- invalid requests - missing name/field in the request body, using a Bad Request Body missing a necessary field:
To make the request:
CREATE_COURSE_FAIL_1 = { "title": "missing description" }
pytest tests/test_create.py::test_create_course_fail_1 -s
- expected stdout:
collected 1 item tests/test_create.py {"detail":[{"loc":["body","description"],"msg":"field required","type":"value_error.missing"}]} - check database table:
postgres=# SELECT * FROM course; id | title | description ----+------------------------+------------------------------- 1 | Intro to Algo | leetcode 2 | Digital World | use jupyter notebook 3 | Computation Structures | most difficult module in ISTD 4 | Discrete Math | sutd doesnt teach (4 rows)
- invalid requests: row already exists. Try insert the same
-
-
either a DELETE or PUT request...
-
that deletes or updates a single resource respectively
-
DELETE
/course, DELETE/student, PUT/course/{course_id}/{student_id} -
make the requests: delete student
Samwell Tarly, courseDiscrete Mathand enroll the first student in the table to the first course in he tablepytest tests/test_delete.py::test_delete_course -s pytest tests/test_delete.py::test_delete_student -s pytest tests/test_put.py::test_single_update -s
-
expected stdout for DELETE:
collected 1 item tests/test_delete.py {"title":"Discrete Math","description":"sutd doesnt teach","id":4,"enrolled_students":[]} collected 1 item tests/test_delete.py {"name":"Samwell Tarly","email":"samwell_tarly@sutd.edu","gpa":5.0,"id":9,"course_id":null} -
expected stdout for PUT:
collected 1 item tests/test_put.py {"name":"Walter White","email":"walter_white@sutd.edu","gpa":5.3,"id":1,"course_id":1}
-
-
show that the resource has indeed been modified through another HTTP request
- for the DELETE, use GET
/course/{course_name}, GET/student/{student_name} - make the requests: GET
/student/Samwell%20Tarlyand GET/course/Discrete%20Mathpytest tests/test_get.py::test_get_student_by_name_for_delete -s pytest tests/test_get.py::test_get_course_by_name_for_delete -s
- expected stdout:
collected 1 item tests/test_get.py {"detail":"Student not found"} collected 1 item tests/test_get.py {"detail":"Course not found"}
indicating that they are indeed already deleted from the table.
- for the PUT, use GET
/course/byid/{course_id}, GET/student/byid/{student_id} - make the requests: GET
/course/byid/1and GET/student/byid/1pytest tests/test_get.py::test_get_course_by_id -s pytest tests/test_get.py::test_get_student_by_id -s
- expected stdout:
collected 1 item tests/test_get.py {"title":"Intro to Algo","description":"leetcode","id":1,"enrolled_students":[{"name":"Walter White","email":"walter_white@sutd.edu","gpa":5.3,"id":1,"course_id":1}]} collected 1 item tests/test_get.py {"name":"Walter White","email":"walter_white@sutd.edu","gpa":5.3,"id":1,"course_id":1}
We can see that the
Coursewith titleIntro to Algohas a newStudentadded to itsenrolled_students, and thecourse_idof theStudent, whose name isWalter White, is also updated.- check the effect of DELETE and PUT by observing the table:
- the newly added rows are deleted, and the foreign key,
course_id, ofWalter Whiteis updated to the course he has enrolled in.postgres=# SELECT * FROM student; id | name | email | gpa | course_id ----+------------------+----------------------------+-----+----------- 2 | Jesse Pinkman | jess_pinkman@sutd.edu | 0.5 | 3 | Gus String | gus_string@sutd.edu | 4.5 | 4 | Hank Schrader | hank_schrader@sutd.edu | 4.5 | 5 | Stannis Bar | stannis_bar@sutd.edu | 2.5 | 6 | Jon Snow | jon_snow@sutd.edu | 2 | 7 | Tyrion Lannister | tyrion_lanniester@sutd.edu | 5 | 8 | Cersei Lannister | cersei_lannister@sutd.edu | 1 | 1 | Walter White | walter_white@sutd.edu | 5.3 | 1 (8 rows)
- for the DELETE, use GET
-
has validation and returns an appropiate HTTP response code if the input data is invalid (e.g. trying to delete a nonexistent user)
-
To validate the request and check if he rows exist in the table for the DELETE
/course, because we have already executed it once previously and there is noCourserow withtitle: Discrete Mathanddescription: sutd doesnt teachandStudentrow withname: Samwell Tarlynow, we can make the DELETE requests again - because these rows do not exist, it will return a404: Trying to delete nonexistent rows -
make the request:
pytest tests/test_delete.py::test_delete_course_validate -s pytest tests/test_delete.py::test_delete_student_validate -s
-
expected stdout:
collected 1 item tests/test_delete.py {"detail":"Trying to delete nonexistent rows."} collected 1 item tests/test_delete.py {"detail":"Trying to delete nonexistent rows."} -
To validate the request and check if he rows exist in the table for the PUT
/course/{course_id}/{student_id}endpoint, we need to reject the request if eitherStudentorCoursedo not exist -
make the requests:
pytest tests/test_put.py::test_single_update_validate_course_not_found -s pytest tests/test_put.py::test_single_update_validate_student_not_found -s
-
expected stdout:
collected 1 item tests/test_put.py {"detail":"Course not Found."} collected 1 item tests/test_put.py {"detail":"Student not Found."}
-
-
-
Identify which routes in your application are idempotent, and provide proof to support your answer.
PUT /course/{course_id}/{student_id}is idempotent: calling it once or several times has the same effect. For example, callingPUT /course/1/1will make sure theStudentwithstudent_id = 1is underCoursewithcourse_id = 1and thatCoursewithcourse_id = 1will haveStudentwithstudent_id = 1in itsenrolled_student- calling multiple times will have the same effect as calling it once.- To prove it, you can make the PUT request
PUT /course/1/1multiple times:
pytest tests/test_put.py::test_single_update -s pytest tests/test_put.py::test_single_update -s pytest tests/test_put.py::test_single_update -s pytest tests/test_put.py::test_single_update -s ...
- The stdout is always:
collected 1 item tests/test_put.py {"name":"Walter White","email":"walter_white@sutd.edu","gpa":5.3,"id":1,"course_id":1}
which is the same result as making the request only once.
-
All GET endpoints are idempotent. The GET requests do not modify any resources on the server or editing the database entries. Running the GET requests multiple times will get the same answer.
-
Both the DELETE endpoints, DELETE
/courseand DELETE/studentare idempotent - deleting the same resoure multiple times have the same effect as running it only once. See the guide on "has validation and returns an appropiate HTTP response code if the input data is invalid" above for an example of running the DELETE requests >1 time and the result is the same - the specified row is deleted. -
PUT
/student/pullup_gpa/{threshold}/{delta}is NOT idempotent. Running it with the same query parameters multiple times will keep adding the students whose GPA is <thresholdbydelta- if the students' updated gpa do not exceedthresholdafter making this request once. Making the same request multiple times could lead to different results compared to running it only once, therefore this PUT endpoint is not idempotent. -
There are 3 POST endpoints, POST
/course, POST/studentand POST/file, and all 3 are idempotent, contrary to common POST endpoints, because all 3 tables that these 3 POST endpoints aim to create resource in, do NOT allow duplicated rows. -
Proof, run POST
/studentwith the same payload multiple times:
pytest tests/test_create.py::test_create_student_success -s pytest tests/test_create.py::test_create_student_success -s pytest tests/test_create.py::test_create_student_success -s ...
- you will notice that the server will give you a 400 error for trying to create duplicated rows after making the request once:
collected 1 item tests/test_create.py {"detail":"This student has already been created."} E assert 400 == 200 E + where 400 = <Response [400]>.status_code tests/test_create.py:36: AssertionError- the table does not allow duplicated rows, the new row for
Samwell Tarlyis added only once:
postgres=# SELECT * FROM student; id | name | email | gpa | course_id ----+------------------+----------------------------+-----+----------- 2 | Jesse Pinkman | jess_pinkman@sutd.edu | 0.5 | 3 | Gus String | gus_string@sutd.edu | 4.5 | 4 | Hank Schrader | hank_schrader@sutd.edu | 4.5 | 5 | Stannis Bar | stannis_bar@sutd.edu | 2.5 | 6 | Jon Snow | jon_snow@sutd.edu | 2 | 7 | Tyrion Lannister | tyrion_lanniester@sutd.edu | 5 | 8 | Cersei Lannister | cersei_lannister@sutd.edu | 1 | 1 | Walter White | walter_white@sutd.edu | 5.3 | 1 10 | Samwell Tarly | samwell_tarly@sutd.edu | 5 |
- Proof, run POST
/coursewith the same payload multiple times:
pytest tests/test_create.py::test_create_course_success -s pytest tests/test_create.py::test_create_course_success -s pytest tests/test_create.py::test_create_course_success -s ...
- you will notice that the server will give you a 400 error for trying to create duplicated rows after making the request once:
collected 1 item tests/test_create.py {"detail":"This course has already been created."} E assert 400 == 200 E + where 400 = <Response [400]>.status_code tests/test_create.py:29: AssertionError- the table does not allow duplicated rows, the new row for
Discrete Mathis added only once:
postgres=# SELECT * FROM course; id | title | description ----+------------------------+------------------------------- 1 | Intro to Algo | leetcode 2 | Digital World | use jupyter notebook 3 | Computation Structures | most difficult module in ISTD 5 | Discrete Math | sutd doesnt teach (4 rows)
-
The POST
fileendpoint is also idempotent because each time a file is upload, a row with the filename asnamecolumn is inserted into tablefile. Because this table does not allow duplicated rows as well, making the same request more than once will have the same effect as making the request only once. -
run POST
/filewith the same payload multiple times: (in this test case, "chinese_meme_1.png")
pytest tests/test_file.py::test_upload_idm -s pytest tests/test_file.py::test_upload_idm -s pytest tests/test_file.py::test_upload_idm -s ...
- you will notice that the server will give you a 400 error for trying to create duplicated rows after making the request once:
collected 1 item tests/test_file.py {"detail":"A file with the same filename already exists."} E assert 400 == 200 E + where 400 = <Response [400]>.status_code tests/test_create.py:29: AssertionError- the table does not have multiple new rows added, the new row for
Discrete Mathis added only once:
postgres=# SELECT * FROM file; id | name ----+-------------------- 1 | chinese_meme_1.png (1 row)
-
Implement at least two of the following challenges:
-
File upload in a POST request, using multipart/form-data
-
POST
/file- add a new row to tablefileand save the image to a folder on disk./app/object_store. returns the path to the file saved localtion on server;- make a request:
pytest tests/test_file.py::test_upload -s
-
expected stdout:
collected 1 item tests/test_file.py "/app/app/object_store/cat.png" -
And you can see a
cat.pngunder./app/object_store. -
A side note: To my knowledge, I think the best way to store large binary assets like image and video is to save them to an Object Store service like AWS S3, or a base64 string in the database table (for images), or, save a path to the asset in the database table and keep the asset somewhere on the server, which is more efficient. For simplicity, I am saving the images here to the server disk and the name of the file to the table
file- the filename in the table will be used to construct the path to the file for the GET request.
-
-
Have a route in your application that returns a content type that is not plaintext
- GET
/file/{filename}, which returns aFileResponse. - make a request:
pytest tests/test_file.py::test_download -s
- expected stdout:
collected 1 item tests/test_file.py <Response [200]>
- I was initially trying to return a base64 string so I could return a HTML text that can be copy-pasted
into a browser
to render into an image. But since this is requiring something not plaintext,
I am returning a
FileResponseof FastAPI here.
- GET
-
Some form of authorization through inspecting the request headers
- the authorization is done with
check_request_header()inmain.py. A request can only be accepted if the header has ax-tokenand the value is the same asSECRET_KEYin the backend server (the value can be found in.env). Thischeck_request_header()is passed as a dependency to all endpoints inmain.py. - make a request with the correct header:
pytest tests/test_heartbeat.py::test_pass_verification -s
- expected stdout:
collected 1 item tests/test_heartbeat.py "The connection is up" - make a request without the correct header:
pytest tests/test_heartbeat.py::test_fail_verification -s
- expected stdout: error message
collected 1 item tests/test_heartbeat.py {"detail":"Unauthorized"}
- the authorization is done with
-
A special route that can perform a batch delete or update of resources matching a certain condition
- PUT
/student/pullup_gpa/{threshold}/{delta}- pull up all students whose gpa is lower thanthresholdbydelta - make the request: PUT
/student/pullup_gpa/4.0/0.5pytest tests/test_put.py::test_batch_update -s
- expected stdout: number of updated rows
collected 1 item tests/test_put.py 4
- check the database table: you can see the students whose GPA is lower than 4.0 are pulled up by 0.5
(Jesse Pinkman, Stannis Bar, Jon Snow, Cersei Lannister)
(This table has a new row for
postgres=# SELECT * FROM student; id | name | email | gpa | course_id ----+------------------+----------------------------+-----+----------- 3 | Gus String | gus_string@sutd.edu | 4.5 | 4 | Hank Schrader | hank_schrader@sutd.edu | 4.5 | 7 | Tyrion Lannister | tyrion_lanniester@sutd.edu | 5 | 1 | Walter White | walter_white@sutd.edu | 5.3 | 1 10 | Samwell Tarly | samwell_tarly@sutd.edu | 5 | 2 | Jesse Pinkman | jess_pinkman@sutd.edu | 1 | 5 | Stannis Bar | stannis_bar@sutd.edu | 3 | 6 | Jon Snow | jon_snow@sutd.edu | 2.5 | 8 | Cersei Lannister | cersei_lannister@sutd.edu | 1.5 | (9 rows)
Samwell Tarly,id=10, which is added by the POST request in the idempotent endpoint proof section earlier. The initialSamwell Tarlywithid=9was deleted by the request made in the DELETE endpoint section.)
- PUT
-
You must provide ample documentation on how to build & run your code and how to make the HTTP requests to your API, as well as what are the expected responses for each request. You will not be deducted if your program is slow or unoptimised, but bonus points may be given if you show meaningful thought in analysing how performance was / can be improved in your application.