Django restful framework生成API文档过程详解
作者:迎风而来
这篇文章主要介绍了Django restful framework生成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访问接口自带的界面如下:
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。