Programmation serveur Python : documentation API utilisant Django-rest-swagger

Avec le développement d'Internet, les applications Web et les API sont de plus en plus courantes. Python est un langage de programmation populaire qui peut être utilisé pour créer des applications Web et des API. En Python, Django est un framework Web puissant qui fournit de nombreuses fonctionnalités utiles, notamment des modèles, des vues et des modèles qui simplifient le développement Web. D'un autre côté, la documentation de l'API est une tâche importante qui aide les développeurs à comprendre la fonctionnalité et l'utilisation de l'API. Dans cet article, nous présenterons comment utiliser Django-rest-swagger pour documenter l'API.

1. Installez Django-rest-swagger

Tout d'abord, vous devez installer Django-rest-swagger. Vous pouvez utiliser pip pour installer :

pip install django-rest-swagger

2. Intégrer django-rest-swagger

Ajouter le contenu suivant au fichier settings.py de Django :# 🎜🎜#

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
}

Ensuite, ajoutez le contenu suivant dans le fichier urls.py de Django :

from rest_framework_swagger.views import get_swagger_view

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

Après avoir terminé la configuration ci-dessus, visitez http://localhost:8000/docs/ Voir l'API page de documentation.

Configuration swagger

Modifiez le fichier settings.py de Django et ajoutez le contenu suivant :

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

Cela rendra L'API renvoie les données du document au format coreapi afin qu'elles puissent être restituées dans l'interface utilisateur Swagger.

Générer la documentation de l'API

Vous pouvez maintenant commencer à écrire des vues API. Ajoutez quelques métadonnées nécessaires à la vue, qui seront utilisées pour générer la documentation de l'API. Par exemple :

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)

Dans cette vue, certaines métadonnées sont ajoutées, telles qu'une brève description, une description des paramètres et une description du retour. Ces métadonnées seront utilisées par Django-rest-swagger pour générer la documentation de l'API.

Voir la documentation de l'API

Maintenant, vous pouvez visiter http://localhost:8000/docs/ pour consulter la documentation de l'API. Dans la page de documentation, vous verrez une liste de toutes les vues API, chacune avec ses propres méthodes, paramètres et instructions de retour. Vous pouvez également tester l'API sur la page pour vérifier si elle fonctionne correctement.

Summary

L'utilisation de django-rest-swagger peut facilement documenter l'API afin que les développeurs puissent comprendre l'utilisation et les fonctions de l'API. Dans cet article, nous expliquons comment intégrer Django-rest-swagger dans Django et générer la documentation de l'API. J'espère que cet article pourra aider les lecteurs à mieux comprendre la programmation du serveur Python et la technologie de documentation des API.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!