的
下面记录在drf中通过swagger生成接口文档的具体实现流程,参考drf swagger文档
3.2 安装django-rest-swagger库
pip3 install django-rest-swagger...),
# swagger接口文档
path('docs/', schema_view, name='docs'),
...
]
3.5 访问查看
完成后重启项目,如果在此之前有进行数据库同步并创建了用户...,那么就可以直接访问接口文档的url,并跳转到drf的认证界面进行登录
swagger界面给人以清爽简约的感觉,通过展开接口还可以对接口(传参)进行测试
?...public: 描述API文档是否公开, 如果未 False, 则仅返回当前用户具有权限的接口endpoints的API文档
validators: 用于校验自动生成的Schema的校验器, 目前仅支持..., 如 cache(指定 cache backend), key_prefix(缓存key的前缀) 等等, 详见django官方文档
需要注意的是, 由于 drf-yasg 支持针对不同用户返回不一样的