Django Rest Framework 自动生成接口文档的方法

要使用 drf 自动生产接口文档的方法，我们需要安装个coreapi的依赖包

pip install coreapi

然后 重启 django进程。

在项目根urls.py中增加如下2行红色字体的内容：

from django.contrib import admin from django.urls import include, path from rest_framework.documentation import include_docs_urls urlpatterns = [     path('admin/', admin.site.urls),     path('', include('project.urls')),     path('docs/', include_docs_urls(title='说明文档')), ]

然后，在项目 settings.py中增加如下3行，不然会提示 'AutoSchema' object has no attribute 'get_link'：

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

重启django后， 访问http://127.0.0.1:8000/docs/ 就会出现如下类似界面，在这个界面里，我们可以做api的调试工作。

image.png