Как установить django rest framework

Django REST Framework

Django REST framework is a powerful and flexible toolkit for building Web APIs.

Some reasons you might want to use REST framework:

• The Web browsable API is a huge usability win for your developers.
• Authentication policies including packages for OAuth1a and OAuth2.
• Serialization that supports both ORM and non-ORM data sources.
• Customizable all the way down — just use regular function-based views if you don’t need the morepowerfulfeatures.
• Extensive documentation, and great community support.
• Used and trusted by internationally recognised companies including Mozilla, Red Hat, Heroku, and Eventbrite.

Funding

REST framework is a collaboratively funded project. If you use REST framework commercially we strongly encourage you to invest in its continued development by signing up for a paid plan.

Every single sign-up helps us make REST framework long-term financially sustainable.

Many thanks to all our wonderful sponsors, and in particular to our premium backers, Sentry, Stream, Spacinov, Retool, bit.io, PostHog, CryptAPI, and FEZTO.

Requirements

REST framework requires the following:

• Python (3.6, 3.7, 3.8, 3.9, 3.10)
• Django (2.2, 3.0, 3.1, 3.2, 4.0, 4.1)

We highly recommend and only officially support the latest patch release of each Python and Django series.

The following packages are optional:

• PyYAML, uritemplate (5.1+, 3.0.0+) — Schema generation support.
• Markdown (3.0.0+) — Markdown support for the browsable API.
• Pygments (2.4.0+) — Add syntax highlighting to Markdown processing.
• django-filter (1.0.1+) — Filtering support.
• django-guardian (1.1.1+) — Object level permissions support.

Installation

Install using pip , including any optional packages you want.

pip install djangorestframework pip install markdown # Markdown support for the browsable API. pip install django-filter # Filtering support 

. or clone the project from github.

git clone https://github.com/encode/django-rest-framework 

Add ‘rest_framework’ to your INSTALLED_APPS setting.

INSTALLED_APPS = [ . 'rest_framework', ] 

If you’re intending to use the browsable API you’ll probably also want to add REST framework’s login and logout views. Add the following to your root urls.py file.

urlpatterns = [ . path('api-auth/', include('rest_framework.urls')) ] 

Note that the URL path can be whatever you want.

Example

Let’s take a look at a quick example of using REST framework to build a simple model-backed API.

We’ll create a read-write API for accessing information on the users of our project.

Any global settings for a REST framework API are kept in a single configuration dictionary named REST_FRAMEWORK . Start off by adding the following to your settings.py module:

REST_FRAMEWORK =

Don’t forget to make sure you’ve also added rest_framework to your INSTALLED_APPS .

We’re ready to create our API now. Here’s our project’s root urls.py module:

from django.urls import path, include from django.contrib.auth.models import User from rest_framework import routers, serializers, viewsets # Serializers define the API representation. class UserSerializer(serializers.HyperlinkedModelSerializer): class Meta: model = User fields = ['url', 'username', 'email', 'is_staff'] # ViewSets define the view behavior. class UserViewSet(viewsets.ModelViewSet): queryset = User.objects.all() serializer_class = UserSerializer # Routers provide an easy way of automatically determining the URL conf. router = routers.DefaultRouter() router.register(r'users', UserViewSet) # Wire up our API using automatic URL routing. # Additionally, we include login URLs for the browsable API. urlpatterns = [ path('', include(router.urls)), path('api-auth/', include('rest_framework.urls', namespace='rest_framework')) ] 

You can now open the API in your browser at http://127.0.0.1:8000/, and view your new ‘users’ API. If you use the login control in the top right corner you’ll also be able to add, create and delete users from the system.

Quickstart

Can’t wait to get started? The quickstart guide is the fastest way to get up and running, and building APIs with REST framework.

Development

See the Contribution guidelines for information on how to clone the repository, run the test suite and contribute changes back to REST Framework.

Support

For support please see the REST framework discussion group, try the #restframework channel on irc.libera.chat , or raise a question on Stack Overflow, making sure to include the ‘django-rest-framework’ tag.

For priority support please sign up for a professional or premium sponsorship plan.

Security

Security issues are handled under the supervision of the Django security team.

Please report security issues by emailing security@djangoproject.com.

The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.

License

Copyright © 2011-present, Encode OSS Ltd. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS «AS IS» AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Documentation built with MkDocs.

Установка Django Rest Framework

На этом занятии мы сделаем первый практический шаг – выполним установку Django REST Framework. Этот пакет устанавливается в проект сайта, работающего на Django. Поэтому вначале нам нужно создать учебный сайт и начать с установки фреймворка Django.

Сначала я думал взять уже готовый проект из предыдущего курса по Django, но потом решил, что будет проще и понятнее, если мы создадим с нуля простое приложение без каких-либо излишеств. Но за основу я возьму все тот же проект по знаменитым женщинам.

Я сейчас не буду подробно объяснять создание проекта сайта на Django, если вы этого не знаете, то смотрите плейлист по этому фреймворку:

Вначале нам нужно создать виртуальное окружение установить туда интерпретатор Python и фреймворк Django. Я все буду делать непосредственно через PyCharm.

У меня уже создана папка drf:

в которую и буду устанавливать виртуальное окружение. Для этого в PyCharm создаем новый проект:

File -> New Project

В поле «Location» прописываем «D:\Python\django\drf». Затем, отмечаем пункт «New environment using» и прописываем путь «D:\Python\django\drf\venv». Убираем галочку «Create a main.py …» и нажимаем кнопку «Create». У нас начинается создание виртуального окружения.

Переходим во вкладку «Terminal» и у нас здесь должно быть уже активное виртуальное окружение (в круглых скобках прописано venv).

Находясь в рабочем каталОге «D:\Python\django\drf» выполняем установку фреймворка Django:

pip install django

После установки создаем проект сайта на django с помощью команды:

django-admin startproject drfsite

(здесь drfsite – название проекта, обычно совпадает с доменным именем сайта).

У нас появится каталОг drfsite с пакетом drfsite и набором известных вам уже файлов. Перейдем в папку drfsite:

И для проверки работоспособности сайта выполним команду:

python manage.py runserver

Если сайт корректно отображается в браузере, значит, все было сделано верно.

Далее, выполним миграции для создания таблиц в БД. В учебных целях я оставлю БД SQLite, чтобы не перегружать материал. В дальнейшем к проекту достаточно просто можно подключить любую другую СУБД. Итак, выполняем команду:

python manage.py migrate

Затем, в файле drfsite/settings.py установим русский язык для нашего сайта:

LANGUAGE_CODE = 'ru'

и поменяем временную зону:

TIME_ZONE = 'Europe/Moscow'

Следующим шагом создадим основное приложение сайта. Так как сайт посвящен известным женщинам, то приложение я назвал women:

python manage.py startapp women

Прописываем наше приложение в списке INSTALLED_APPS установленных приложений (в файле drfsite/settings.py):

INSTALLED_APPS = [ . 'women.apps.WomenConfig', ]

Далее, нам нужны будут модели для работы с таблицами БД. Я возьму классы моделей из курса по Django, где мы создавали таблицу для хранения информации по женщинам, а также отдельную таблицу category, которая содержала категории женщин: певицы, актрисы, спортсменки и т.п.

В файле women/models.py, прописываем следующие классы:

from django.db import models class Women(models.Model): title = models.CharField(max_length=255) content = models.TextField(blank=True) time_create = models.DateTimeField(auto_now_add=True) time_update = models.DateTimeField(auto_now=True) is_published = models.BooleanField(default=True) cat = models.ForeignKey('Category', on_delete=models.PROTECT, null=True) def __str__(self): return self.title class Category(models.Model): name = models.CharField(max_length=100, db_index=True) def __str__(self): return self.name

Как видите, я записываю все по минимуму. После определения классов моделей нам нужно создать для них миграции:

python manage.py makemigrations

python manage.py migrate

Следующий шаг – это создание суперюзера в нашем проекте, чтобы мы могли заходить в админ-панель и добавлять информацию в наши таблицы. Для этого выполним команду:

python manage.py createsuperuser

Здесь нам будет предложено указать логин (имя пользователя). В учебных целях я укажу root. Далее, нужно ввести адрес электронной почты, пусть это будет root@drfsite.ru. (Почта может быть не существующей в учебном проекте, а вообще, нужно указывать адрес реальной почты, на которую будут приходить служебные сообщения). И, наконец, вводим пароль (1234) и повторяем его.

Все, суперпользователь создан и мы теперь можем войти в админку, указав root и пароль 1234. Запускаем тестовый веб-сервер:

python manage.py runserver

Переходим по адресу:

Чтобы в админ-панели появилось наше приложение Women его нужно зарегистрировать. Для этого откроем файл women/admin.py, который отвечает за взаимосвязь приложения с админкой, где мы будем регистрировать наши модели. Вначале импортируем их:

from .models import *

и зарегистрируем модель Women:

admin.site.register(Women)

Возвращаемся в админку и при обновлении главной страницы видим наше приложение и зарегистрированную модель Women. Если щелкнуть по ней, то видим список наших записей и здесь же можем их редактировать, удалять и добавлять новые.

Однако сейчас у нас нет ни одной категории. Чтобы сейчас не писать лишний код, я добавлю две категории в таблицу Category с помощь программы

Введем: 1 – актрисы; 2 – певицы. Теперь мы можем выбирать одну из двух категорий. Добавим несколько записей (берем заготовку).

Установка Django REST Framework

Все, наше тестовый учебный проект готов и теперь мы можем приступить непосредственно к установке Django REST Framework. Выполним команду:

pip install djangorestframework

Далее, нам нужно его зарегистрировать как приложение. Переходим в файл drfsite/settings.py и в коллекции INSTALLED_APPS прописываем строчку:

INSTALLED_APPS = [ . 'rest_framework', ]

В принципе все, пакет установлен и готов к работе. Чтобы увидеть его в действии нам в программе нужно определить представление, которое будет срабатывать на запрос от пользователя и сериализатор. Начнем с представления, которые мы с вами уже много раз делали в проекте на Django. Здесь то же самое. Переходим в файл women/views.py и записываем следующий класс для DRF:

from rest_framework import generics from .models import Women class WomenAPIView(generics.ListAPIView): queryset = Women.objects.all() serializer_class = WomenSerializer

Наш класс WomenAPIView наследуется от базового ListAPIView, который берется из DRF и реализует функционал по формированию JSON-списка из записей таблицы Women.

Чтобы представление «знало» как формировать ответ, нужно определить класс сериализатора WomenSerializer. Для этого создадим еще один файл serializers.py в приложении women и определим класс WomenSerializer:

from rest_framework import serializers from .models import Women class WomenSerializer(serializers.ModelSerializer): class Meta: model = Women fields = ('title', 'cat_id')

Пока здесь вам может быть далеко не все понятно. Мы обо всем подробно будем говорить на последующих занятиях. Сейчас я просто показываю пример использования Django REST Framework не более того.

Последним шагом нам нужно прописать маршрут для активации представления. Переходим в файл drfsite/urls.py и записываем:

from women.views import * urlpatterns = [ path('admin/', admin.site.urls), path('api/v1/womenlist/', WomenAPIView.as_view()), ]

Все готово. Давайте протестируем. Запускаем веб-сервер:

python manage.py runserver

Переходим по адресу:

и видим ответ в виде JSON-строки со списком данных из таблицы Women:

Этот формат вывод JSON ответа в веб-браузере определен в пакете Django REST Framework для возможности тестирования создаваемого API. Конечному устройству будет передаваться только JSON-строка и заголовок ответа. Далее, приложение, которое отправляло этот API-запрос, может выполнить парсинг полученных данных и, например, отобразить их на экране смартфона. Так происходит взаимодействие между сайтом и другими сторонними приложениями.

Из этого занятия вам достаточно понять, как устанавливается Django REST Framework, а в качестве практики, попробуйте повторить этот тестовый пример.

Видео по теме

#1. Django REST Framework — что это такое

#2. Установка Django Rest Framework

#3. Базовый класс APIView для представлений

#4. Введение в сериализацию. Класс Serializer

#5. Методы save(), create() и update() класса Serializer

#6. Класс ModelSerializer и представление ListCreateAPIView

#7. Представления UpdateAPIView и RetrieveUpdateDestroyAPIView

#8. Viewsets и ModelViewSet

#9. Роутеры: SimpleRouter и DefaultRouter

#10. Ограничения доступа (permissions)

#11. Авторизация и аутентификация. Session-based authentication

#12. Аутентификация по токенам. Пакет Djoser

#13. Идея авторизации по JWT-токенам

#14. Делаем авторизацию по JWT-токенам

#15. Добавляем пагинацию (pagination)

© 2023 Частичное или полное копирование информации с данного сайта для распространения на других ресурсах, в том числе и бумажных, строго запрещено. Все тексты и изображения являются собственностью сайта

Установка Django Rest Framework

Отредактируйте файл settings.py приложения educa и добавьте rest_framework в настройки INSTALLED_APPS:

INSTALLED_APPS = ( # . 'rest_framework', ) 

Затем добавьте следующий код в файл settings.py:

REST_FRAMEWORK = < 'DEFAULT_PERMISSION_CLASSES': [ 'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly' ] > 

Можно гибко настраивать API используя параметр REST_FRAMEWORK. REST Framework предоставляет широкий набор параметров для настройки поведения по умолчанию. Параметр DEFAULT_PERMISSION_CLASSES определяет разрешения по умолчанию для чтения, создания, обновления или удаления объектов. Мы установили DjangoModelPermissionsOrAnonReadOnly как единственный класс доступов по умолчанию. Этот класс основывается на системе доступов Django, позволяя пользователям создавать, обновлять или удалять объекты, обеспечивая доступ только для чтения анонимным пользователям. Дополнительные сведения о разрешениях будут позже.

Чтобы узнать больше о настройках REST framework, посетите страницу: http://www.django-rest-framework.org/api-guide/settings/

results matching » «

No results matching » «

Разработка Web API на Django с помощью Django REST framework: от создания моделей до тестирования

Django REST framework (DRF) — это мощный и гибкий инструмент для создания Web API на основе Django. Он предоставляет удобные средства для создания RESTful API, поддерживает аутентификацию, авторизацию, сериализацию, валидацию и другие функции.

В этой статье мы рассмотрим, как использовать Django REST framework для создания Web API на базе Django.

Шаг 1: Установка Django REST framework

Первым шагом является установка Django REST framework. Вы можете установить его с помощью pip:

pip install djangorestframework

Шаг 2: Создание проекта Django

Для создания проекта Django используйте команду:

django-admin startproject myproject

Шаг 3: Создание приложения Django

Создайте приложение Django с помощью команды:

python manage.py startapp myapp

Шаг 4: Настройка Django REST framework

INSTALLED_APPS = [ . 'rest_framework', 'myapp', ]

Добавьте REST framework middleware в MIDDLEWARE в файле settings.py:

MIDDLEWARE = [ . 'rest_framework.middleware.AuthenticationMiddleware', 'rest_framework.middleware.AuthorizationMiddleware', ]

Шаг 5: Создание модели Django

Определите модель Django в файле models.py вашего приложения:

from django.db import models class Product(models.Model): name = models.CharField(max_length=100) description = models.TextField() price = models.DecimalField(max_digits=10, decimal_places=2) created_at = models.DateTimeField(auto_now_add=True) updated_at = models.DateTimeField(auto_now=True) def __str__(self): return self.name

Шаг 6: Создание сериализатора Django REST framework

Определите сериализатор Django REST framework в файле serializers.py вашего приложения:

from rest_framework import serializers from myapp.models import Product class ProductSerializer(serializers.ModelSerializer): class Meta: model = Product fields = ['id', 'name', 'description', 'price', 'created_at', 'updated_at']

Шаг 7: Создание представления Django REST framework

Определите представление Django REST framework в файле views.py вашего приложения:

from rest_framework import generics from myapp.models import Product from myapp.serializers import ProductSerializer class ProductList(generics.ListCreateAPIView): queryset = Product.objects.all() serializer_class = ProductSerializer class ProductDetail(generics.RetrieveUpdateDestroyAPIView): queryset = Product.objects.all() serializer_class = Product

Шаг 8: Настройка маршрутов Django REST framework

Определите маршруты Django REST framework в файле urls.py вашего приложения:

from django.urls import path from myapp.views import ProductList, ProductDetail urlpatterns = [ path('products/', ProductList.as_view(), name='product-list'), path('products//', ProductDetail.as_view(), name='product-detail'), ]

Шаг 9: Запуск приложения Django

Запустите приложение Django с помощью команды:

python manage.py runserver

Шаг 10: Тестирование Web API

Откройте веб-браузер и перейдите по адресу http://127.0.0.1:8000/products/. Вы должны увидеть список всех продуктов.

Чтобы создать новый продукт, отправьте POST-запрос на http://127.0.0.1:8000/products/ с данными в формате JSON:

Чтобы получить детали конкретного продукта, отправьте GET-запрос на http://127.0.0.1:8000/products/1/, где 1 — идентификатор продукта.

Чтобы обновить продукт, отправьте PUT-запрос на http://127.0.0.1:8000/products/1/ с данными в формате JSON:

Чтобы удалить продукт, отправьте DELETE-запрос на http://127.0.0.1:8000/products/1/.

В этой статье мы рассмотрели, как использовать Django REST framework для создания Web API на базе Django. Django REST framework предоставляет удобные средства для создания RESTful API, поддерживает аутентификацию, авторизацию, сериализацию, валидацию и другие функции. С его помощью вы можете быстро и легко создавать мощные и гибкие Web API на базе Django.