Erstellen einer RESTful Django API: Eine Schritt-für-Schritt-Anleitung

Die Erstellung einer RESTful-API mit Django ist ein unkomplizierter Prozess. In diesem Blog-Beitrag stellen wir eine Schritt-für-Schritt-Anleitung zur Verfügung, wie man eine einfache RESTful-API mit Django erstellt.

Schritt 1: Django installieren

Der erste Schritt bei der Erstellung einer RESTful-API mit Django ist die Installation von Django. Dazu muss der Python-Paketmanager pip installiert sein. Sobald Sie pip installiert haben, können Sie Django mit dem folgenden Befehl installieren:

pip install django

Schritt 2: Erstellen eines neuen Django-Projekts

Sobald Django installiert ist, können Sie mit dem folgenden Befehl ein neues Projekt erstellen:

django-admin startproject myproject

Dadurch wird ein neues Projekt namens myproject im aktuellen Verzeichnis erstellt.

Schritt 3: Django REST Framework installieren

Nun, da wir ein neues Django-Projekt haben, können wir Django REST Framework installieren, um unsere API zu erstellen. Dazu verwenden wir wieder den pip-Paketmanager.

pip install djangorestframework

Schritt 4: Eine App erstellen

Der nächste Schritt besteht darin, eine App innerhalb unseres Projekts zu erstellen. Wir können dies mit dem folgenden Befehl tun:

python manage.py startapp myapp

Schritt 5: Hinzufügen der App zum Projekt

Da wir nun eine App haben, müssen wir sie zum Projekt hinzufügen. Dazu müssen wir die Datei settings.py im Projekt öffnen und die App in die Liste INSTALLED_APPS aufnehmen.

INSTALLED_APPS = [
    ...
    'myapp',
]

Schritt 6: Erstellen der Modelle

Nun, da unsere Anwendung dem Projekt hinzugefügt wurde, können wir die Modelle für unsere API erstellen. Dazu fügen wir den folgenden Code in die Datei models.py innerhalb der App ein.

from django.db import models

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

Schritt 7: Erstellen der Serialisierer

Sobald wir unsere Modelle haben, können wir die Serialisierer für unsere API erstellen. Dazu müssen wir den folgenden Code in die Datei serializers.py innerhalb der App einfügen.

from rest_framework import serializers
from .models import MyModel

class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        Model = MyModel
        fields = ('name', 'description')

Schritt 8: Erstellen der Ansichten

Nun, da wir unsere Modelle und Serialisierer haben, können wir die Ansichten für unsere API erstellen. Dazu müssen wir den folgenden Code in die Datei views.py innerhalb der Anwendung einfügen.

from rest_framework import generics
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelList(generics.ListCreateAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

class MyModelDetail(generics.RetrieveUpdateDestroyAPIView):
    Queryset = MyModel.objects.all()
    serializer_class = MeinModellSerialisierer

Schritt 9: Erstellen der URLs

Der nächste Schritt besteht darin, die URLs für unsere API zu erstellen. Dazu müssen wir den folgenden Code in die Datei urls.py innerhalb der Anwendung einfügen.

from django.urls import path
from .views importieren MyModelList, MyModelDetail

urlpatterns = [
    path('mymodels/', MyModelList.as_view()),
    path('mymodels/<int:pk>/', MyModelDetail.as_view()),
]

Schritt 10: Erstellen der Projekt-URLs

Zum Schluss müssen wir die URLs der Anwendung zu den Projekt-URLs hinzufügen. Dazu müssen wir den folgenden Code in die Datei urls.py im Projekt einfügen.

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

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

Und das war's! Ihre einfache RESTful-API mit Django ist nun einsatzbereit.

Keywords

Django Python

Technologien

Dienstleistungen