目錄4、訪問介面文件網頁
5、兩點說明
rest framework可以自動幫助我們生成介面文件。
介面文件以網頁的方式呈現。
自動介面文件能生成的是繼承自apiview及其子類的檢視。
rest framewrok生成介面文件需要coreapi庫的支援。
pip install coreapi文件路由對應的檢視配置為rest_framework.documentation.include_docs_urls，
引數title為介面文件**的標題。
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:
修改圖書的閱讀量
"""
# attributeerror: 'autoschema' object has no attribute 'get_link'
# 解決：配置檔案新增配置
rest_framework =
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 在總路由中新增介面文件路徑。文件路由對應的檢視配置...
API介面文件 自動生成
rest framework可以自動幫助我們生成介面文件。介面文件以網頁的方式呈現。自動介面文件能生成的是繼承自apiview及其子類的檢視。安裝依賴包 pip install coreapisettings.py rest framework 在總路由中新增介面文件路徑 from rest fra...
自動生成apidoc介面文件
開發過程中，個人認為編寫介面文件是個很煩人的事，沒有或者隨便寫，前端對接的時候不清楚就更煩人了。使用aoidoc可以簡化這個操作，可我有時候連apidoc的注釋都懶得寫 api management smhard insert 新增 apiname insert apigroup 智慧型裝置 api...