前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Django Rest Framework 自动生成接口文档的方法

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

作者头像
保持热爱奔赴山海
发布2020-05-25 16:55:05
2.8K1
发布2020-05-25 16:55:05
举报
文章被收录于专栏:数据库相关

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

代码语言:javascript
复制
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' }

代码语言:javascript
复制

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

image.png
image.png
本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2020/05/22 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档