{"id":6667,"date":"2023-08-21T09:10:57","date_gmt":"2023-08-21T09:10:57","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=6667"},"modified":"2023-08-22T04:19:02","modified_gmt":"2023-08-22T04:19:02","slug":"django-rest-api","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/django-tutorial\/django-rest-api\/","title":{"rendered":"Django REST API"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you will learn how to use build a simple API that returns a list of todos and a detail of a todo using Django only.<\/p>\n\n\n\n

Creating a virtual environment #<\/a><\/h2>\n\n\n\n

First, create a new directory called django_rest_api<\/code>:<\/p>\n\n\n

mkdir django_rest_api<\/code><\/span><\/pre>\n\n\n
Second, navigate to the django_rest_api<\/code> directory:<\/p>\n\n\n
cd django_rest_api<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
python -m venv venv<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Fourth, activate the virtual environment:<\/p>\n\n\n
venv\/scripts\/activate<\/code><\/span><\/pre>\n\n\n
Fifth, install the django<\/code> package using pip command:<\/p>\n\n\n
pip install django<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Finally, create the requirements.txt<\/code> file:<\/p>\n\n\n
pip freeze > requirements.txt<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Creating a new Django project #<\/a><\/h2>\n\n\n\n
First, create a new Django project called todolist<\/code>:<\/p>\n\n\n
django-admin startproject todolist<\/code><\/span><\/pre>\n\n\n
Second, navigate to the project directory:<\/p>\n\n\n
cd todolist<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Creating a new Django app #<\/a><\/h2>\n\n\n\n
First, create a new app called todo<\/code> inside the todolist<\/code> project:<\/p>\n\n\n
django-admin startapp todo<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, register the todo<\/code> app in the settings.py<\/code> of the todolist<\/code> project<\/p>\n\n\n
INSTALLED_APPS = [\n    ...\n    'todo.apps.TodoConfig'<\/span>,\n]<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Defining the Todo model #<\/a><\/h2>\n\n\n\n
First, define the Todo<\/code> model in the models.py<\/code> of the todo<\/code> app:<\/p>\n\n\n
from<\/span> django.db import<\/span> models\nfrom<\/span> django.contrib.auth.models import<\/span> User\n\n\nclass<\/span> Todo<\/span>(models.Model)<\/span>:<\/span>\n    title = models.CharField(max_length=255<\/span>)\n    completed = models.BooleanField(default=False<\/span>)\n    user = models.ForeignKey(User, on_delete=models.CASCADE)\n\n    def<\/span> __str__<\/span>(self)<\/span>:<\/span>\n        return<\/span> self.title<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The Todo<\/code> model has three fields: title<\/code>, completed<\/code>, and user<\/code>. <\/p>\n\n\n\n
The user<\/code> references the User<\/code> model of the django<\/code> package, which specifies the account that created the todo. <\/p>\n\n\n\n
Second, register the Todo<\/code> model to the admin site by modifying the code in the admin.py<\/code> in the todo<\/code> app:<\/p>\n\n\n
from<\/span> django.contrib import<\/span> admin\nfrom<\/span> .models import<\/span> Todo\n\nadmin.site.register(Todo)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
By doing this, you can manage the todo<\/code> on the Django admin site.<\/p>\n\n\n\n
Making migrations & migrate models #<\/a><\/h2>\n\n\n\n
First, make a new migration:<\/p>\n\n\n
python manage.py makemigrations<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, migrate the migrations to sync the models to the database:<\/p>\n\n\n
python manage.py migrate<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Third, create a super admin user to sign in to Django’s admin site:<\/p>\n\n\n
python manage.py createsuperuser<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Let’s call the user john<\/code>.<\/p>\n\n\n\n
Finally, start the Django development server:<\/p>\n\n\n
python manage.py runserver<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Creating some todos #<\/a><\/h2>\n\n\n\n
First, log in to the admin site via the URL http:\/\/localhost:8000\/admin<\/code> using the superuser john<\/code> created above:<\/p>\n\n\n\n
\"django-rest-api<\/figure>\n\n\n\n
And add some todos:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Building an API with Django #<\/a><\/h2>\n\n\n\n
We’ll build an API with Django only. The API will have two endpoints:<\/p>\n\n\n\n
Third, create a virtual environment<\/a> using the built-in venv<\/code> module:<\/p>\n\n\n