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

  • Z时代
  • 2024-01-10
  • 分类：综合

自动生成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访问接口自带的界面如下：

以上是 Django restful framework生成API文档过程详解 的全部内容， 来源链接： utcz.com/z/356353.html

回到顶部