django rest framework使用drf_yasg生成swaggers在线API文档
简介
企业中使用django rest framework开发比较常见的,对于前后端分离多人协作开发过程中,对于接口文档是非常的重要,能够避免非常高的沟通成本
大家在使用drf开发过程中有很多接口可以直接使用model和serializer直接完成,我下面介绍的drf_yasg也可以根据这些信息来自动生成接口文档,在对接成本上几乎很小
大家如果觉得该项目不错也可以给作者点个star喔
- git地址: drf-yasg
使用
支持的相关版本,最新支持请见drf-yasg
- Django Rest Framework: 3.10, 3.11, 3.12
- Django: 2.2, 3.0, 3.1
- Python: 3.6, 3.7, 3.8, 3.9
安装
|
|
修改settings.py
|
|
修改urls.py
|
|
通常我们使用下面的即可
|
|