DRF中自动生成API文档
Posted sui776265233
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了DRF中自动生成API文档相关的知识,希望对你有一定的参考价值。
自动生成api文档(不管是函数视图还是类视图都能显示)
1.安装rest_framework_swagger库
pip install django-rest-swagger
2.在项目下的 urls.py 中加入如下:
from rest_framework_swagger.views import get_swagger_view schema_view = get_swagger_view(title=‘API文档‘) urlpatterns += [ path(r‘docs/‘, schema_view), ]
3.在创建的django项目下的settings中加入如下:
INSTALLED_APPS = [‘rest_framework_swagger‘] REST_FRAMEWORK = ‘DEFAULT_SCHEMA_CLASS‘: ‘rest_framework.schemas.AutoSchema‘
4、生成的api文档界面如下:
5、DRF访问接口自带的界面如下:
以上是关于DRF中自动生成API文档的主要内容,如果未能解决你的问题,请参考以下文章
xadmin引入drf-yasg生成Swagger API文档