django自动生成接口文档
先pip安装coreapi包
pip install coreapi
小知识(这里不需要使用):导出pip所有的包到txt文件中
pip freeze > requestment.txt
这个是从文件里用pip安装所有的包
pip install -r requestment.txt
配置,在urls.py
导包,然后在urlpatterns加入,取名称
from rest_framework.documentation import include_docs_urls
urlpatterns = [
url(r'docs/', include_docs_urls(title='接口文档'))
]
在对应的serializers.py文件设置备注
在需要写备注的序列化器的class Meta里写额外备注:
class Meta:
# 补充说明
extra_kwargs =

本文档介绍如何在Django项目中利用coreapi包自动生成接口文档。首先,通过pip安装coreapi。接着,配置urls.py,导入所需模块并添加到urlpatterns。在serializers.py文件中为序列化器添加备注,特别是class Meta中的额外说明。最后,展示如何访问生成的接口文档页面。
最低0.47元/天 解锁文章
1249

被折叠的 条评论
为什么被折叠?



