Django生成接口文档-阿里云开发者社区

Django生成接口文档

2023-10-25 153

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 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)