Python服务器编程：使用django-rest-swagger进行API文档化-Python教程-PHP中文网

Python服务器编程：使用django-rest-swagger进行API文档化

PHPz

发布： 2023-06-18 22:55:39

原创

814人浏览过

随着互联网的发展，web应用和api越来越普遍。python是一种流行的编程语言，可以用于构建web应用和api。在python中，django是一个强大的web框架，它提供了许多有用的功能，包括简化web开发的模型、视图和模板。另一方面，api的文档化是一个重要的任务，可以帮助开发人员了解api的功能和用法。在本文中，将介绍如何使用django-rest-swagger对api进行文档化。

安装django-rest-swagger

首先，需要安装django-rest-swagger。可以使用pip来安装：

pip install django-rest-swagger

登录后复制

集成django-rest-swagger

在Django的settings.py文件中加入以下内容：

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
}

登录后复制

然后，在Django的urls.py文件中添加以下内容：

from rest_framework_swagger.views import get_swagger_view

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

登录后复制

做完上述配置后，访问 http://localhost:8000/docs/ 就能看到API文档页面了。

配置swagger

修改Django的settings.py文件，添加以下内容：

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

登录后复制

这将使API返回coreapi格式的文档数据，从而可以在Swagger UI中进行渲染。

生成API文档

现在可以开始编写API视图了。在视图中添加一些必要的元数据，这些元数据将用于生成API文档。例如：

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)

登录后复制

在这个视图中，添加了一些元数据，如简要描述、参数说明和返回说明。这些元数据将被django-rest-swagger用于生成API文档。