Django — это мощный фреймворк для создания веб-приложений на Python. В этой статье мы рассмотрим, как создать простой API с использованием GET и POST запросов в проекте Django. Мы будем использовать встроенные инструменты Django, такие как views и urls, чтобы реализовать базовый функционал.

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

Если у вас еще нет проекта Django, вы можете создать его с помощью следующих команд:

django-admin startproject myproject
cd myproject

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

python manage.py startapp api

Не забудьте добавить созданное приложение (api) в список INSTALLED_APPS в файле settings.py:

INSTALLED_APPS = [
    # ...
    'api',
]

Шаг 2: Создание модели данных

Для примера создадим простую модель Item, которая будет содержать название и описание элемента. Откройте файл models.py в приложении api и добавьте следующий код:

from django.db import models

class Item(models.Model):
    name = models.CharField(max_length=100)
    description = models.TextField()

    def __str__(self):
        return self.name

После создания модели выполните миграции:

python manage.py makemigrations
python manage.py migrate

Шаг 3: Создание сериализатора

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

from rest_framework import serializers
from .models import Item

class ItemSerializer(serializers.ModelSerializer):
    class Meta:
        model = Item
        fields = ['id', 'name', 'description']

Примечание: Если вы используете Django REST Framework (DRF), вам нужно установить его через pip:

pip install djangorestframework

И добавить 'rest_framework' в INSTALLED_APPS в settings.py.

Шаг 4: Создание представлений (Views)

Теперь создадим представления для обработки GET и POST запросов. Мы будем использовать классовые представления Django REST Framework.

Откройте файл views.py в приложении api и добавьте следующий код:

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from .models import Item
from .serializers import ItemSerializer

class ItemList(APIView):
    def get(self, request):
        items = Item.objects.all()
        serializer = ItemSerializer(items, many=True)
        return Response(serializer.data)

    def post(self, request):
        serializer = ItemSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

В этом коде мы создали класс ItemList, который обрабатывает два типа запросов:

• GET: Возвращает список всех объектов Item.
• POST: Создает новый объект Item на основе данных, отправленных в теле запроса.

Шаг 5: Настройка URL-маршрутов

Теперь настроим маршруты для нашего API. Откройте файл urls.py в приложении api и добавьте следующий код:

from django.urls import path
from .views import ItemList

urlpatterns = [
    path('items/', ItemList.as_view(), name='item-list'),
]

Также не забудьте подключить маршруты приложения к основному файлу urls.py проекта:

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('api.urls')),
]

Теперь API будет доступен по адресу /api/items/.

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

Запустите сервер разработки Django:

python manage.py runserver

GET запрос

Вы можете отправить GET запрос, чтобы получить список всех элементов. Используйте браузер или инструменты, такие как Postman или curl:

curl http://127.0.0.1:8000/api/items/

Ответ будет в формате JSON:

[
    {
        "id": 1,
        "name": "Item 1",
        "description": "This is the first item"
    },
    {
        "id": 2,
        "name": "Item 2",
        "description": "This is the second item"
    }
]

POST запрос

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

curl -X POST -H "Content-Type: application/json" -d '{"name": "New Item", "description": "This is a new item"}' http://127.0.0.1:8000/api/items/

Если запрос успешен, вы получите ответ с созданным объектом:

{
        "id": 3,
        "name": "New Item",
        "description": "This is a new item"
    }

Заключение

Мы создали простой API с использованием Django и Django REST Framework, который поддерживает GET и POST запросы. Этот API позволяет получать список элементов и создавать новые записи в базе данных.

Вы можете расширить этот пример, добавив поддержку других HTTP методов (PUT, DELETE) или внедрив аутентификацию и авторизацию для защиты вашего API.

Удачи в разработке!