自动生成api接口文档,是restframework自带的功能,生成的文档超级详细,既省去了后端人员写文档的时间,也能让前端用起来欲仙欲死.
不过因为是restframework的功能,目前只能生成调用了restframework类视图的接口,普通的view视图接口不会生成,当然这只是我自己测试了一下后得出的结论,可能有别的方法,这里就不讨论这个,咱们进入正题
restframework 自动生成api文档
- 安装依赖
pip install coreapi
- settings中的配置
INSTALLED_APPS = [
....
'rest_framework',
]
- urls中的配置
from rest_framework.documentation import include_docs_urls
urlpatterns = [
....
url(r'docs/', include_docs_urls(title="鲍勃")),
]
Snipaste_2018-07-09_16-58-12.png
接口自定义描述
-
在视图函数中,写注释视图类.png
-
在serializer类中,写help_text序列化类.png
-
修改完后的效果图Snipaste_2018-07-09_17-10-49.png
还有很多功能,这里就不多说了.
