Jak stworzyć API w Django Rest Framework? Przewodnik po podstawach

Django to jeden z najpopularniejszych frameworków webowych, który umożliwia tworzenie dynamicznych aplikacji w Pythonie. Jeśli tworzysz aplikacje webowe, prawdopodobnie spotkałeś się z Django, a być może zastanawiasz się nad tworzeniem API. I tu wkracza Django Rest Framework (DRF), które daje nam potężne narzędzie do budowy API w Django. W tym artykule pokażemy Ci, czym jest Django Rest, jak go zainstalować, oraz jak zbudować pierwsze API z przykładami, które możesz od razu wykorzystać!

Co to jest Django Rest Framework?

Django Rest Framework (DRF) to rozszerzenie Django, które upraszcza proces tworzenia API. API, czyli interfejsy programowania aplikacji, pozwalają na komunikację między różnymi systemami. Dzięki DRF możesz w łatwy sposób tworzyć API oparte na HTTP, które będzie mogło służyć zarówno do obsługi zapytań GET, POST, PUT, jak i DELETE.

DRF zapewnia wysokiej jakości serializację danych, autentykację, obsługę paginacji oraz inne mechanizmy, które upraszczają tworzenie profesjonalnych aplikacji. Dzięki DRF możesz szybko i efektywnie tworzyć RESTful API, które jest podstawą większości nowoczesnych aplikacji webowych i mobilnych. Co ważne, Django Rest Framework jest otwartym źródłem, co oznacza, że jest bezpłatne i stale rozwijane przez społeczność programistów.

Dlaczego warto używać Django Rest?

Jest wiele powodów, dla których warto sięgnąć po Django Rest Framework. Oto najważniejsze z nich:

• Łatwość integracji: DRF jest w pełni kompatybilne z Django, więc możesz łatwo zintegrować je z już istniejącymi projektami opartymi na tym frameworku.
• Elastyczność: DRF pozwala na tworzenie API w różnorodny sposób – od prostych po bardziej zaawansowane aplikacje z autentykacją, autoryzacją czy zaawansowaną obsługą błędów.
• Potężne możliwości: Dzięki DRF masz dostęp do funkcji takich jak serializacja, paginacja, filtrowanie danych, które znacznie ułatwiają życie programisty.
• Wsparcie społeczności: Django Rest Framework ma dużą społeczność, co oznacza, że zawsze możesz liczyć na pomoc w przypadku problemów.

Jak zainstalować Django Rest Framework?

Przed przystąpieniem do tworzenia API z użyciem DRF musisz zainstalować odpowiednie pakiety. Na szczęście proces ten jest szybki i prosty. Oto jak zainstalować Django Rest Framework:

# Najpierw zainstaluj Django (jeśli jeszcze tego nie zrobiłeś)
pip install django

# Następnie zainstaluj Django Rest Framework
pip install djangorestframework

Po zainstalowaniu DRF musisz dodać "rest_framework" do listy zainstalowanych aplikacji w pliku settings.py twojego projektu Django:

INSTALLED_APPS = [
    ...
    'rest_framework',
]

Tworzenie pierwszego API w Django Rest Framework

Po zainstalowaniu Django Rest Framework, pora na stworzenie pierwszego API. Załóżmy, że chcesz stworzyć proste API, które umożliwia dodawanie, edytowanie i usuwanie książek. Oto jak to zrobić:

1. Tworzymy model

Zaczynamy od stworzenia modelu, który będzie odpowiadał za przechowywanie danych o książkach. W tym celu tworzymy nową aplikację w projekcie Django:

# Tworzymy nową aplikację
python manage.py startapp books

Teraz w pliku models.py aplikacji books dodajemy model książki:

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=200)
    author = models.CharField(max_length=200)
    published_date = models.DateField()
    isbn = models.CharField(max_length=13)
    page_count = models.IntegerField()

    def __str__(self):
        return self.title

Model zawiera podstawowe informacje o książce: tytuł, autora, datę publikacji, numer ISBN oraz liczbę stron. Po utworzeniu modelu należy przeprowadzić migrację bazy danych:

# Tworzymy migrację
python manage.py makemigrations

# Przeprowadzamy migrację bazy danych
python manage.py migrate

2. Tworzymy serializer

Aby nasze dane mogły być łatwo przekształcone na format JSON, musimy stworzyć serializer. Serializer w Django Rest Framework to klasa, która konwertuje dane modelu do formatu JSON oraz odwrotnie – z JSON na model. Tworzymy nowy plik serializers.py w aplikacji books:

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = ['id', 'title', 'author', 'published_date', 'isbn', 'page_count']

W tym przypadku używamy wbudowanej klasy ModelSerializer, która automatycznie generuje pola na podstawie naszego modelu Book.

3. Tworzymy widok API

Kolejnym krokiem jest stworzenie widoku API, który będzie obsługiwał nasze zapytania HTTP. W Django Rest Framework możemy używać różnych typów widoków – od prostych widoków funkcji po bardziej zaawansowane klasy widoków. W tym przypadku użyjemy klasy ListCreateAPIView, która obsługuje zarówno wyświetlanie listy książek, jak i tworzenie nowych:

from rest_framework import generics
from .models import Book
from .serializers import BookSerializer

class BookListCreate(generics.ListCreateAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

4. Tworzymy URL-e

Teraz musimy zdefiniować URL-e dla naszego API. Tworzymy plik urls.py w aplikacji books, w którym zdefiniujemy ścieżki do naszych widoków:

from django.urls import path
from .views import BookListCreate

urlpatterns = [
    path('books/', BookListCreate.as_view(), name='book-list-create'),
]

Na koniec musimy dodać nasz plik urls.py aplikacji books do głównych URL-i projektu w pliku urls.py:

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

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

5. Testujemy API

Teraz możesz uruchomić serwer i przetestować swoje API:

python manage.py runserver

Przejdź do przeglądarki i wejdź pod adres http://localhost:8000/api/books/, aby zobaczyć listę książek. Możesz także użyć narzędzia takiego jak Postman, aby wysłać zapytanie POST i dodać nową książkę.

Podsumowanie

Django Rest Framework to potężne narzędzie do tworzenia API w Django. Dzięki niemu możesz w prosty sposób stworzyć profesjonalne i skalowalne API, które będzie działać w Twojej aplikacji. W tym artykule pokazaliśmy Ci, jak stworzyć swoje pierwsze API krok po kroku, używając Django Rest. Pamiętaj, że DRF oferuje wiele innych funkcji, takich jak autentykacja, paginacja, filtrowanie czy walidacja danych, które pozwolą Ci na rozbudowę API o bardziej zaawansowane opcje. Z pewnością pomoże Ci to stworzyć naprawdę potężne aplikacje!