Python-Serverprogrammierung: API-Dokumentation mit Django-Rest-Swagger

Mit der Entwicklung des Internets werden Webanwendungen und APIs immer häufiger. Python ist eine beliebte Programmiersprache, die zum Erstellen von Webanwendungen und APIs verwendet werden kann. In Python ist Django ein leistungsstarkes Web-Framework, das viele nützliche Funktionen bereitstellt, darunter Modelle, Ansichten und Vorlagen, die die Webentwicklung vereinfachen. Andererseits ist die Dokumentation einer API eine wichtige Aufgabe, die Entwicklern hilft, die Funktionalität und Verwendung der API zu verstehen. In diesem Artikel stellen wir vor, wie man Django-Rest-Swagger zur Dokumentation der API verwendet.

1. Django-Rest-Swagger installieren

Zuerst müssen Sie Django-Rest-Swagger installieren. Sie können pip zum Installieren verwenden:

pip install django-rest-swagger

2. Integrate django-rest-swagger

Fügen Sie den folgenden Inhalt zur Datei „settings.py“ von Django hinzu:

INSTALLED_APPS = [
    # ...
    'rest_framework',
    'rest_framework_swagger',
]

MIDDLEWARE = [
    # ...
    'corsheaders.middleware.CorsMiddleware',
    'django.middleware.common.CommonMiddleware',
]

SWAGGER_SETTINGS = {
    'USE_SESSION_AUTH': False, #关闭session认证
    'APIS_SORTER': 'alpha',
    'JSON_EDITOR': True
}

Fügen Sie dann den folgenden Inhalt zur Datei „urls.py“ von Django hinzu:

from rest_framework_swagger.views import get_swagger_view

schema_view = get_swagger_view(title='API Document')
urlpatterns = [
    # ...
    url(r'^docs/', schema_view),
]

Nachdem Sie die obige Konfiguration abgeschlossen haben, besuchen Sie http://localhost:8000/docs/, um die API-Dokumentationsseite anzuzeigen.

3. Swagger konfigurieren

Ändern Sie die Datei „settings.py“ von Django und fügen Sie den folgenden Inhalt hinzu:

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}

Dadurch gibt die API Dokumentdaten im Coreapi-Format zurück, damit sie in der Swagger-Benutzeroberfläche gerendert werden können.

4. API-Dokumentation generieren

Jetzt können Sie mit dem Schreiben von API-Ansichten beginnen. Fügen Sie der Ansicht einige erforderliche Metadaten hinzu, die zum Generieren der API-Dokumentation verwendet werden. Beispiel:

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import authentication, permissions

class HelloWorld(APIView):
    """
    简要描述API的功能
    """
    authentication_classes = [authentication.TokenAuthentication]
    permission_classes = [permissions.IsAuthenticated]

    def get(self, request, format=None):
        """
        获取数据

        所需参数：
        * param1 - 参数1说明
        * param2 - 参数2说明

        返回数据：
        * status - response的状态
        """
        content = {'message': 'Hello, World!'}
        return Response(content)

In dieser Ansicht werden einige Metadaten hinzugefügt, z. B. eine kurze Beschreibung, eine Parameterbeschreibung und eine Rückgabebeschreibung. Diese Metadaten werden von django-rest-swagger verwendet, um API-Dokumentation zu generieren.

5. API-Dokumentation anzeigen

Jetzt können Sie http://localhost:8000/docs/ besuchen, um die API-Dokumentation anzuzeigen. Auf der Dokumentationsseite sehen Sie eine Liste aller API-Ansichten, jede mit ihren eigenen Methoden, Parametern und Rückgabeanweisungen. Sie können die API auch auf der Seite testen, um zu überprüfen, ob sie ordnungsgemäß funktioniert.

Zusammenfassung

Mit django-rest-swagger kann die API einfach dokumentiert werden, sodass Entwickler die Verwendung und Funktionalität der API verstehen können. In diesem Artikel stellen wir vor, wie man Django-Rest-Swagger in Django integriert und API-Dokumentation generiert. Ich hoffe, dass dieser Artikel den Lesern helfen kann, die Python-Serverprogrammierung und die API-Dokumentationstechnologie besser zu verstehen.

Das obige ist der detaillierte Inhalt vonPython-Serverprogrammierung: API-Dokumentation mit Django-Rest-Swagger. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!