Django生成接口文档

当我们使用Django开发Web应用的时候，API接口文档的编写是非常必要的。通常我们会使用Swagger、apidoc等工具来自动生成API文档。本文介绍如何使用Django Rest Framework自动生成接口文档。

安装Django Rest Framework

在项目中安装Django Rest Framework（DRF）：

pip install djangorestframework

在settings.py中添加‘rest_framework’:

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

配置API文档页面

在urls.py中添加API文档页面的URL和视图：

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    # ...
    url(r'^docs/', include_docs_urls(title='API文档')),
]

此时访问http://localhost:8000/docs/就可以看到生成的API文档页面了。

编写API文档视图

我们可以为不同的API视图编写不同的API文档视图，以满足不同的需求。在下面的例子中，我们定义了一个MyAPIView视图，并编写了一个对应的API文档视图。

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.schemas import AutoSchema

class MyAPIView(APIView):
    """
    A simple API View with GET and POST methods.
    """
    schema = AutoSchema()  # 自动创建API文档的Schema
    
    def get(self, request, *args, **kwargs):
        response = {'message': 'Hello, World!'}
        return Response(response)

    def post(self, request, *args, **kwargs):
        response = {'message': 'Got some data!', 'data': request.data}
        return Response(response)

在上面的代码中，我们使用了AutoSchema()方法来自动创建详细的API文档，它可以根据视图方法名、方法参数和返回值等信息自动生成文档信息。

测试API文档

现在我们已经准备好了API文档视图，让我们在API文档页面中查看它。访问http://localhost:8000/docs/，然后单击“MyAPIView”链接，您将看到一个包含视图的所有方法的表单。在Get和Post方法下面，可以看到基于自动模式创建的详细文档。

现在我们已经学习了如何使用Django Rest Framework自动生成API文档。使用这种方法，我们可以方便地为Django Rest Framework Web应用程序生成自动文档。

Loading_create