当前位置:首页 >> 脚本专栏

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文档界面如下:

Django restful framework生成API文档过程详解

5、DRF访问接口自带的界面如下:

Django restful framework生成API文档过程详解

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。