suchen
HeimBackend-EntwicklungPython-TutorialDjango Rest-Framework mit Swagger

Was können Sie von diesem Artikel erwarten?

In diesem Artikel geht es um die Implementierung von Swagger in einem Django-Rest-Framework-Projekt; wir werden an unserer Kontenverwaltung arbeiten

Serienbestellung

Schauen Sie sich bei Interesse frühere Artikel an!

  1. KI-Projekt von Grund auf, die Idee, lebendiges Tagebuch
  2. Beweisen Sie, dass es mit Google AI Studio machbar ist
  3. Django API-Projekt-Setup
  4. Django-Kontenverwaltung (1), Registrierung und Aktivierung
  5. Django-Kontenverwaltung (2), anmelden und Passwort ändern
  6. Swagger mit Django Rest Framework (Sie sind hier?)

Installation und Einrichtung

Der beste Swagger-Generator, den ich für das Rest-Framework gefunden habe, ist drf-yasg, aber ich bin offen für Vorschläge, wenn Sie einen besseren kennen!
Beginnen wir mit der Paketinstallation

pip install drf-yasg

Jetzt gehe ich zu unserer Einstellungsdatei

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'drf_yasg', #new
    'corsheaders',
    'rest_framework',
    'django_filters',
    'app_account',
    'app_admin',
    'app_main',
]

SWAGGER_SETTINGS = {
   'LOGIN_URL' : '/api/account/login/',
   'SECURITY_DEFINITIONS': {
      'Bearer': {
            'type': 'apiKey',
            'name': 'Authorization',
            'in': 'header'
      }
   }
}

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    ],
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema'
}

alive_diary/settings.py

Wir haben die drf_yasg-App zu den installierten Apps hinzugefügt und die Standardauthentifizierungsmethode auf Bearer-JWT-Token eingestellt.

Jetzt zur URLs-Datei

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


from rest_framework.documentation import include_docs_urls # new
from rest_framework.schemas import get_schema_view # new

from drf_yasg.views import get_schema_view # new
from drf_yasg import openapi # new

schema_view = get_schema_view(
    openapi.Info(
        title="Swagger API",
        default_version='v1',
    ),
    public=True,
)
API_DESCRIPTION = 'A Web API for creating and editing.' # new
API_TITLE = 'API' # new

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

    path('docs/', include_docs_urls(title=API_TITLE,description=API_DESCRIPTION)), # new
    path('swagger/', schema_view.with_ui('swagger',cache_timeout=0),name="swagger-schema"), # new
]

das ist es! tolle Arbeit!
Lass es uns versuchen

python manage.py runserver 0.0.0.0:8555 

Das Öffnen von http://localhost:8555/swagger/ sollte so aussehen

Django Rest framework with Swagger

Testen von Swagger mit benutzerdefiniertem ApiView

Beginnen wir mit der Anmeldung über die Login-API-Ansicht in Swagger

Django Rest framework with Swagger

Dann authentifizieren wir uns mithilfe der Schaltfläche „Autorisieren“ oben auf der Swagger-Seite. Stellen Sie sicher, dass Sie das Zugriffstoken verwenden, und vergessen Sie nicht den Bearer davor: „Bearer token...“

Django Rest framework with Swagger

Versuchen wir mal, das Passwort mit Swagger zu ändern

Django Rest framework with Swagger

es ist leer! Swagger konnte das Anforderungsschema nicht erkennen. Der einfachste Weg, es anzupassen, ist die Verwendung des automatischen Swagger-Schemas

from drf_yasg.utils import swagger_auto_schema #new


class AccountChangePasswordView(APIView):
    permission_classes = (IsAuthenticated,)
    renderer_classes = [CustomRenderer, BrowsableAPIRenderer]

    @swagger_auto_schema(request_body=ChangePasswordSerializer) # new
    def post(self, request, *args, **kwargs):
        serializer = ChangePasswordSerializer(data=request.data)

        if not serializer.is_valid():
            raise APIException(serializer.errors)

        user = request.user
        password = serializer.validated_data.get("password")
        new_password = serializer.validated_data.get("new_password")

        if not user.check_password(password):
            raise APIException("invalid_password")

        user.set_password(new_password)
        user.save()

        return Response("success")

Jetzt sieht es gut aus

Django Rest framework with Swagger

Wir können jetzt alle authentifizierten Anfragen mit Swagger testen! Im nächsten Artikel geht es zurück zur Konten-App

Bleiben Sie dran ?

Das obige ist der detaillierte Inhalt vonDjango Rest-Framework mit Swagger. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn
Wie erstellen Sie mehrdimensionale Arrays mit Numpy?Wie erstellen Sie mehrdimensionale Arrays mit Numpy?Apr 29, 2025 am 12:27 AM

Durch die folgenden Schritte können mehrdimensionale Arrays mit Numpy erstellt werden: 1) Verwenden Sie die Funktion numpy.array (), um ein Array wie NP.Array ([1,2,3], [4,5,6]) zu erstellen, um ein 2D-Array zu erstellen; 2) Verwenden Sie np.zeros (), np.ones (), np.random.random () und andere Funktionen, um ein Array zu erstellen, das mit spezifischen Werten gefüllt ist; 3) Verstehen Sie die Form- und Größeneigenschaften des Arrays, um sicherzustellen, dass die Länge des Unterarrays konsistent ist und Fehler vermeiden. 4) Verwenden Sie die Funktion np.reshape (), um die Form des Arrays zu ändern. 5) Achten Sie auf die Speichernutzung, um sicherzustellen, dass der Code klar und effizient ist.

Erklären Sie das Konzept des 'Rundfunks' in Numpy -Arrays.Erklären Sie das Konzept des 'Rundfunks' in Numpy -Arrays.Apr 29, 2025 am 12:23 AM

SendeminnumpyissamethodtoperformoperationsonarraysofdifferentShapesByAutomaticaligningTHem.itsimplifiesCode, Verbesserung der Verschiebbarkeit, und BoostSPerformance.her'Showitworks: 1) kleinereArraysArepaddedwithonestOMatchDimens.2) compatibledimens

Erklären Sie, wie Sie zwischen Listen, Array.Array und Numpy -Arrays für die Datenspeicherung auswählen.Erklären Sie, wie Sie zwischen Listen, Array.Array und Numpy -Arrays für die Datenspeicherung auswählen.Apr 29, 2025 am 12:20 AM

Forpythondatastorage, ChooselistsforflexibilitätswithmixedDatatypes, Array.Arrayformemory-effizientesHomogenoususnumericalData und NumpyArraysForAdvancedNumericalComputing.ListsareversAntileffictionForLarGenicalDataSetsetaSets;

Geben Sie ein Beispiel für ein Szenario an, in dem die Verwendung einer Python -Liste angemessener wäre als die Verwendung eines Arrays.Geben Sie ein Beispiel für ein Szenario an, in dem die Verwendung einer Python -Liste angemessener wäre als die Verwendung eines Arrays.Apr 29, 2025 am 12:17 AM

PythonlistsarebetterTterThanarraysFormAnagingDiversedatatypes.1) ListScanholdElements ofdifferenttypes, 2) siearedynamic, erlauben EasyDitionSsandremovals, 3) sie antelluitive Operationenslikesklikationen, Buth), sie ohne Ereignis-effosidentandslowentlaunenfeuer.

Wie können Sie in einem Python -Array auf Elemente zugreifen?Wie können Sie in einem Python -Array auf Elemente zugreifen?Apr 29, 2025 am 12:11 AM

ToaccesselementSinapythonarray, useIndexing: my_array [2] AccessaThThirtelement, returning3.pythonuseszero-basiertindexing.1) usepositiveAndnegativeIndexing: my_list [0] fORGHEFIRSTELEMENT, MY_LIST [-1] Forthelast.2) VerwendungsforArange: my_list [1: 5] extractsselemen

Ist das Tupelverständnis in Python möglich? Wenn ja, wie und wenn nicht warum?Ist das Tupelverständnis in Python möglich? Wenn ja, wie und wenn nicht warum?Apr 28, 2025 pm 04:34 PM

In Artikel wird die Unmöglichkeit des Tupelverständnisses in Python aufgrund von Syntax -Mehrdeutigkeiten erörtert. Alternativen wie die Verwendung von Tuple () mit Generatorausdrücken werden vorgeschlagen, um Tupel effizient zu erstellen (159 Zeichen)

Was sind Module und Pakete in Python?Was sind Module und Pakete in Python?Apr 28, 2025 pm 04:33 PM

Der Artikel erläutert Module und Pakete in Python, deren Unterschiede und Verwendung. Module sind einzelne Dateien, während Pakete Verzeichnisse mit einer __init__.py -Datei sind, die verwandte Module hierarchisch organisieren.

Was ist Docstring in Python?Was ist Docstring in Python?Apr 28, 2025 pm 04:30 PM

In Artikel werden Docstrings in Python, deren Nutzung und Vorteile erörtert. Hauptproblem: Bedeutung von DocStrings für die Code -Dokumentation und -zugriffsfunktion.

See all articles

Heiße KI -Werkzeuge

Undresser.AI Undress

Undresser.AI Undress

KI-gestützte App zum Erstellen realistischer Aktfotos

AI Clothes Remover

AI Clothes Remover

Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

Undress AI Tool

Undress AI Tool

Ausziehbilder kostenlos

Clothoff.io

Clothoff.io

KI-Kleiderentferner

Video Face Swap

Video Face Swap

Tauschen Sie Gesichter in jedem Video mühelos mit unserem völlig kostenlosen KI-Gesichtstausch-Tool aus!

Heiße Werkzeuge

SublimeText3 Linux neue Version

SublimeText3 Linux neue Version

SublimeText3 Linux neueste Version

SecLists

SecLists

SecLists ist der ultimative Begleiter für Sicherheitstester. Dabei handelt es sich um eine Sammlung verschiedener Arten von Listen, die häufig bei Sicherheitsbewertungen verwendet werden, an einem Ort. SecLists trägt dazu bei, Sicherheitstests effizienter und produktiver zu gestalten, indem es bequem alle Listen bereitstellt, die ein Sicherheitstester benötigen könnte. Zu den Listentypen gehören Benutzernamen, Passwörter, URLs, Fuzzing-Payloads, Muster für vertrauliche Daten, Web-Shells und mehr. Der Tester kann dieses Repository einfach auf einen neuen Testcomputer übertragen und hat dann Zugriff auf alle Arten von Listen, die er benötigt.

SublimeText3 chinesische Version

SublimeText3 chinesische Version

Chinesische Version, sehr einfach zu bedienen

VSCode Windows 64-Bit-Download

VSCode Windows 64-Bit-Download

Ein kostenloser und leistungsstarker IDE-Editor von Microsoft

PHPStorm Mac-Version

PHPStorm Mac-Version

Das neueste (2018.2.1) professionelle, integrierte PHP-Entwicklungstool