backend/api/models.py
Create School model with the following fields:
name : CharField with max_length of 255 chars, null and blank set as False.
open_hour: TimeField, null and blank set as True.
close_hour: TimeField, null and blank set as True.
Note: In this first model definition, the name field does not have Unique and db_collation attributes.
backend/api/migrations/0006_school.py
After creating the model, I ran the makemigrations command and the initial migration for the School model was created.
backend/api/migrations/0007_add_collation_unique_to_name_school.py
This is a manual migration file created to add Unique and case-insensitive attributes to name field in School model.
backend/api/CustomField.py
Created a custom TimeField that allows blank values calle BlankableTimeField.
Django by default doesn't allow blank for TimeFields.
backend/api/serializers/SchoolSerializer.py
Created a Model serializer for School. Note that we are using the BlankableTimeField for open and close hour.
Added the validate_name method to check if the name is unique, doing so at Serializer level allow us to handle the exception returned as a Validation Error with a Bad request status code. If we don't have this validation, it will happen at model level and an Internal Server Error will be thrown.
backend/api/views/SiteView.py
Created a Model View set for School with the following features:
Sort by name
Search by name
The data is returned paginated.
backend/api/urls.py
Added a router to generate the endpoints for School.
backend/api/fixtures/setup_data.json
Added data for an school object.
I applied the migrations running the migrate command. Then load the fixture data with loaddata command.
Swagger
The endpoints are accessible through Swagger:
I tried each of the new endpoints successfully. I was able to create, delete, patch and get an school.
I tried the search and sort functionality while getting the schools.
When posting and patching, I got the expected error for entering invalid data.
This PR addresses issue #16
Implementation
Note: In this first model definition, the name field does not have Unique and db_collation attributes.
backend/api/migrations/0006_school.py After creating the model, I ran the
makemigrationscommand and the initial migration for the School model was created.backend/api/migrations/0007_add_collation_unique_to_name_school.py This is a manual migration file created to add Unique and case-insensitive attributes to name field in School model.
backend/api/CustomField.py Created a custom TimeField that allows blank values calle
BlankableTimeField. Django by default doesn't allow blank for TimeFields.backend/api/serializers/SchoolSerializer.py Created a Model serializer for School. Note that we are using the BlankableTimeField for open and close hour.
Added the validate_name method to check if the name is unique, doing so at Serializer level allow us to handle the exception returned as a Validation Error with a Bad request status code. If we don't have this validation, it will happen at model level and an Internal Server Error will be thrown.
The data is returned paginated.
backend/api/urls.py Added a router to generate the endpoints for School.
backend/api/fixtures/setup_data.json
Added data for an school object.
I applied the migrations running the migrate command. Then load the fixture data with
loaddatacommand.Swagger
The endpoints are accessible through Swagger:
I tried each of the new endpoints successfully. I was able to create, delete, patch and get an school. I tried the search and sort functionality while getting the schools. When posting and patching, I got the expected error for entering invalid data.