19 自動生成介面文件

pip install coreapi

from rest_framework.documentation import include_docs_urls

urlpatterns = [
...path('docs/', include_docs_urls(title='站點頁面標題'))
]

class booklistview(generics.listapiview):

"""返回所有圖書資訊.
"""

class booklistcreateview(generics.listcreateapiview):

"""get:
返回所有圖書資訊.
post:
新建圖書.
"""

class bookinfoviewset(mixins.listmodelmixin, mixins.retrievemodelmixin, genericviewset):

"""list:
返回圖書列表資料
retrieve:
返回圖書詳情資料
latest:
返回最新的圖書資料
read:
修改圖書的閱讀量

兩點說明：

1） 檢視集viewset中的retrieve名稱，在介面文件**中叫做read

2）引數的description需要在模型類或序列化器類的字段中以help_text選項定義，如：

class student(models.model):

...age = models.integerfield(default=0, verbose_name='年齡', help_text='年齡')
...

class studentserializer(serializers.modelserializer):

class meta:
model = student
fields = "__all__"
extra_kwargs = 
}

自動生成介面文件

rest framework可以自動幫助我們生成介面文件。介面文件以網頁的方式呈現。自動介面文件能生成的是繼承自apiview及其子類的檢視。rest framewrok生成介面文件需要coreapi庫的支援。pip install coreapi 在總路由中新增介面文件路徑。文件路由對應的檢視配置...

自動生成介面文件

目錄4 訪問介面文件網頁 5 兩點說明 rest framework可以自動幫助我們生成介面文件。介面文件以網頁的方式呈現。自動介面文件能生成的是繼承自apiview及其子類的檢視。rest framewrok生成介面文件需要coreapi庫的支援。pip install coreapi在總路由中新...

API介面文件 自動生成

rest framework可以自動幫助我們生成介面文件。介面文件以網頁的方式呈現。自動介面文件能生成的是繼承自apiview及其子類的檢視。安裝依賴包 pip install coreapisettings.py rest framework 在總路由中新增介面文件路徑 from rest fra...