rest framework可以自動幫助我們生成介面文件。
介面文件以網頁的方式呈現。
自動介面文件能生成的是繼承自apiview及其子類的檢視。
安裝依賴包
pip install coreapi....
'rest_framework',]
在總路由中新增介面文件路徑
from rest_framework.documentation import include_docs_urls
urlpatterns = [
...url(r'^docs/', include_docs_urls(title='api介面文件'))
]
包含多個方法的檢視，在類檢視的文件字串中，分開方法定義，如
class booklistcreateview(generics.listcreateapiview):
"""get:
返回所有圖書資訊.
post:
新建圖書.
"""
對於檢視集viewset，仍在類檢視的文件字串中分開定義，但是應使用action名稱區分
class bookinfoviewset(mixins.listmodelmixin, mixins.retrievemodelmixin, genericviewset):
"""list:
返回圖書列表資料
retrieve:
返回圖書詳情資料
latest:
返回最新的圖書資料
read:
修改圖書的閱讀量
"""
注意1. 檢視集viewset中的retrieve名稱，在介面文件**中叫做read
2. 引數，的description（描述說明）需要在模型類或序列化器類的字段中以help_text選項定義
class bookinfo(models.model):
...readcount= models.integerfield(default=0, verbose_name='閱讀量', help_text='閱讀量')
...
class bookserializer(serializers.modelserializer):
class meta:
model = bookinfo
fields = '__all__'
extra_kwargs =
}
API文件自動生成
1 安裝coreapi pip install coreapi 2 在路由配置文件鏈結 from rest framework.documentation import include docs urls urlpatterns path docs include docs urls title 站...
API文件自動生成
1 安裝coreapi pip install coreapi 2 在路由配置文件鏈結 from rest framework.documentation import include docs urls urlpatterns path docs include docs urls title 站...
ApiDoc 自動生成API文件
1 確認已經安裝node.js 可以使用npm命令 否則要先安裝node 2 安裝apidoc 命令列執行 npminstall apidoc g 3 在專案的當前目錄下編寫乙個指令碼genapidoc.bat 內容為 apidoc o doc apidoc pause 將生成的api文件 o 輸出...