自動(dòng)生成api接口文檔,是restframework自帶的功能,生成的文檔超級(jí)詳細(xì),既省去了后端人員寫(xiě)文檔的時(shí)間,也能讓前端用起來(lái)欲仙欲死.
不過(guò)因?yàn)槭莚estframework的功能,目前只能生成調(diào)用了restframework類視圖的接口,普通的view視圖接口不會(huì)生成,當(dāng)然這只是我自己測(cè)試了一下后得出的結(jié)論,可能有別的方法,這里就不討論這個(gè),咱們進(jìn)入正題
restframework 自動(dòng)生成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
接口自定義描述
-
在視圖函數(shù)中,寫(xiě)注釋視圖類.png
-
在serializer類中,寫(xiě)help_text序列化類.png
-
修改完后的效果圖Snipaste_2018-07-09_17-10-49.png
還有很多功能,這里就不多說(shuō)了.
