This project is a creation of a simple template for django application. Contains GET and POST methods for API and the structure can be applied to other contexts.
-
Virtual environment
- First a virtual environment must be created for the installation of the other packages that will be needed for the application. For this project the Intellij Community IDE will be used.
-
Django Installation
- To install the django framework it is necessary to use the command below
pip install django djangorestframework
- Now the packages related to the API will be created inside the project folder, so be careful to type the following command inside the correct directory. This step is very important:
- Note: library can be renamed to a setup
django-admin startproject library .
- The next step is to install the application inside the created folder, one API can have many applications, in this case, it is going to be called Registration, since it will simulate a data registration:
django-admin startapp registration
At this point it is possible to start the application using the command:
python manage.py runserver
Django by default creates a MySQL database. To finish configuring this part of the project, some settings are required. First, a database migration is requested so that some standard tables are created.
python manage.py migrate
You can access all the project's settings in the file settings.py, including the settings for the database that was created.
In the installed files section you need to add all the applications that were included during the creation of the project. In this example, the registration application has been created, so at the end of the list the name will be added according to the name you created. It is also necessary to inform which framework is being used, in this case 'rest_framework' must be added to the end of the list too.
This file is responsible to map the main behaviors of the data, usually each model maps one database table. For each type of field used, a data type must be set. For this project the following data types were used:
cpf = models.IntegerField(primary_key=True, editable=False)
nome = models.CharField(max_length=255)
dataNascimento = models.DateField(auto_now_add=True)
estado = models.CharField(max_length=70)
cep = models.IntegerField()
For project organization, inside each application's directory, a folder must be created for the serializers and views of that respective application.
The principle of a serializer is to transform data so that it can be stored and transmitted to be utilized in other context but without losing information, even if its format is different. Some can be simple, just to map data like a dictionary, others can be more complex at the point of executing validations that can check the final data translation process. In this case, all the fields in the model were added, this was made explicit in the line:
fields = '_all_'
The view is responsible for joining what has been translated in the serializer, that is, what has been defined in the model, and delivering it to a template. It is in this layer that the application logic is defined.
To create the routes, the file urls.py needs to be changed. In this file all routes to access the API will be created.
Finally, it is necessary to update the model with everything that has been created, for this the following command is necesary:
python manage.py makemigrations
And to include the changes in the database:
python manage.py migrate
And to test:
python manage.py runserver