Создайте REST API с помощью Django REST Framework

Если вы использовали цифровое устройство для отправки и получения информации, вы использовали API. Разработчики создают API, чтобы пользователи могли взаимодействовать с данными из своих приложений.

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

Вы можете использовать платформу Django REST для создания REST API и использовать его для отображения данных из базы данных.

Использование Django с REST API

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

Также у вас должно быть предустановлено следующее:

1. Последняя версия питона.
2. Последняя версия пипа.
3. Pipenv (хотя вместо этого вы можете использовать venv, если хотите.)
4. Последняя версия Джанго.

После того, как вы установили все необходимое программное обеспечение, вы готовы начать.

1. Установите Django REST Framework

REST-фреймворк Джанго — это мощный набор инструментов, который можно использовать для создания и настройки веб-API. Его настраиваемые функции делают его популярным выбором для создания REST API.

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

пипенв установить джангорестфреймворк

2. Создайте приложение Джанго

Следующие инструкции объяснят, как создать приложение для еды, чтобы собирать названия и описания популярных кенийских блюд. API будет получать запросы из базы данных, чтобы пользователи могли взаимодействовать с этими данными.

Приложения Django оснащены базой данных SQLite, поэтому вам не нужно устанавливать другую базу данных.

Чтобы создать приложение Django, сначала создайте проект с именем еда с помощью следующей команды:

django-admin стартовый проект еда 

Затем создайте приложение Django с именемкенийская еда:

django-admin startapp kenyanfood

3. Зарегистрируйте настройки проекта приложения

Зарегистрируйтекенийская едаприложение в настройках проекта под УСТАНОВЛЕННЫЕ ПРИЛОЖЕНИЯ множество. Если вы пропустите этот шаг, Django не распознает приложение. Также зарегистрируйте фреймворк Django REST в тех же настройках:

# Определение приложения
УСТАНОВЛЕННЫЕ_ПРИЛОЖЕНИЯ = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'кенийская еда',
'rest_framework',
]

4. Зарегистрировать URL-адреса приложений

регистр кенийская еда URL-адреса приложений в проекте urls.py файл, как показано ниже:

от django.contrib Импортировать администратор
от django.urls Импортировать путь, включить
URL-шаблоны = [
 путь('администратор/', admin.site.urls),
 путь('', включать('kenyanfood.urls')),
]

5. Создать представление для API

Создайте фиктивный вид в приложении просмотры.py файл, поэтому приложение не выдает ошибок. Сначала импортируйте Ответ объект и@apiview декоратор из фреймворка Django REST.

Ответ помогает вернуть стерилизованные данные в JSON формат, в то время как @apiview отображает API.

от django.shortcuts Импортировать оказывать
от rest_framework.response Импортировать Ответ
от rest_framework.decorators Импортировать API_view
# Создайте свои представления здесь.
@api_view(['ПОЛУЧАТЬ'])
дефполучить еду(запрос):
возвращаться Ответ()

6. Создайте URL-путь для приложения

Создайте URL-адрес для созданного вами представления API. Эта конечная точка отображает кенийская едаданные.

от django.urls Импортировать путь
от. Импортировать Просмотры
от django.conf Импортировать настройки
URL-шаблоны = [
 путь('', просмотры.getFood),
 путь('почта/', просмотры.postFood),
]

7. Создайте модель для приложения

Класс модели приложения называется Еда. Это должно выглядеть так:

от django.db Импортировать модели
# Создавайте свои модели здесь.
сортЕда(модели. Модель):
 имя = модели. CharField (max_length=200)
 описание = модели. CharField (max_length=500)

Зарегистрируйте модель в приложении admin.py файл, как показано ниже:

от django.contrib Импортировать администратор
от .модели Импортировать Еда
# Зарегистрируйте свои модели здесь.
администратор.сайт.регистр(Еда)

8. Сделать миграции

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

питонуправлять.pyмиграциякенийская еда

Затем примените эти миграции, выполнив эту команду:

питонуправлять.pyмигрировать

Успешная миграция будет выглядеть так:

Успешные миграции означают, что база данных создала таблицы для кенийская едаПриложение.

9. Добавить данные в базу данных

Использовать Джанго администратор Графический интерфейс для ввода данных в базу данных. Джанго администратор имеет отличный интерфейс для визуализации и управления данными вашего приложения.

Кроме того, вы можете использовать оболочку python в командной строке, чтобы вручную ввести данные в базу данных. В этом руководстве вы будете использовать интерфейс администратора Django.

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

питонуправлять.pyсоздает суперпользователя

При появлении запроса введите свой имя пользователя, адрес электронной почты и пароль. Затем вы можете открыть страницу администратора, используя ссылку ниже:

http://127.0.0.1:8000/admin/

Вы увидите страницу входа:

После входа в систему вы увидите интерфейс администрирования Django с Группы и Пользователи модель. Оба они предназначены для аутентификации; в Еда модель находится в разделе ниже.

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

Теперь, когда в базе данных есть данные, создайте API

10. Сериализация модели

Сериализаторы конвертировать сложные модели Django в JSON объектов, что упрощает чтение данных в API. Сериализация делает данные более читабельными в API.

Создайте новый файл в приложении с именем сериализатор.py

от rest_framework Импортировать сериализаторы
от .модели Импортировать Еда
сортFoodSerializer(сериализаторы. ModelSerializer):
сортМета:
 модель=Еда
 поля=('имя','описание')

Вы импортируете сериализаторы модуль из rest_framework упаковать и создать FoodSerializer класс, который наследуется от ModelSerializer сорт.

Далее укажите Еда модель, которую вы хотите сериализовать, и поля, которые вы хотите добавить в API.

11. Обновить представление

Затем обновите представление API с помощью сериализатор и Еда модели.

Во-первых, определите ПОЛУЧАТЬ метод для извлечения всех данных из базы данных с Еда. Объекты.все() функция. Затем сериализуйте данные и верните их в качестве ответа в JSON формат.

от django.shortcuts Импортировать оказывать
от rest_framework.response Импортировать Ответ
от rest_framework.decorators Импортировать API_view
от .модели Импортировать Еда
от .сериализатор Импортировать FoodSerializer
# Создайте свои представления здесь.
@api_view(['ПОЛУЧАТЬ'])
дефполучить еду(запрос):
 еда = Еда.объекты.все()
 сериализатор = FoodSerializer (еда, много =Истинный)
возвращаться Ответ (serializer.data)

Затем перейдите по ссылке URL-адреса сервера:

https://127.0.0.1:8000/

Вы увидите API, отображающий данные из базы данных:

Поздравляем, вы создали REST API!

12. Добавить данные с помощью метода POST

Проверьте, можете ли вы использовать REST API для добавления данных в базу данных.

Во-первых, определите ПОЧТА метод в представлении.

@api_view(['ПОЧТА'])
дефпостЕда(запрос):
 сериализатор = FoodSerializer (данные = запрос. данные)
еслисериализатор.действует():
сериализатор.сохранять()
возвращаться Ответ (serializer.data)

Затем добавьте путь в приложение urls.py создать конечную точку для API ПОЧТА функциональность.

URL-шаблоны = [
 путь('',просмотры.getFood),
 путь('почта/',views.postFood),
]

Затем перейдите по этому URL-адресу:

https://127.0.0.1:8000/post

Вы увидите ПОЧТА конечная точка. Добавьте данные в базу данных в JSON формат в Содержание раздел и нажмите кнопку ПОЧТА кнопка. Например, добавьте новый продукт питания со следующей структурой:

{ "имя":"Мазива мала", "описание":"Простокваша" }

Вы увидите данные, отображаемые красным цветом в JSON формат.

Теперь, если вы вернетесь к ПОЛУЧАТЬ конечная точка http://127.0.0.1:8000/, вы увидите еду ‘Мазива мала, и его описание добавлено.

Теперь у вас есть REST API, который может отображать и добавлять элементы в приложение. Как насчет того, чтобы поэкспериментировать с другими CRUD методы? Работать с ОБНОВЛЯТЬ и УДАЛИТЬ методы увеличат функциональность вашего REST API.

Как создать REST API с помощью Django

Теперь вы можете создать REST API с помощью Django. Сначала создайте приложение с моделью, сериализуйте данные и создайте функцию просмотра. Затем включите конечные точки URL для визуализации данных в формате JSON.

Создание REST API с помощью Django REST framework — это удобный способ обмена данными и повышения качества обслуживания пользователей.