API文件自動生成

1、安裝coreapi

pip install coreapi

2、在路由配置文件鏈結

from rest_framework.documentation import

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

3、檢視類：自動介面文件能生成的是繼承自apiview及其子類的檢視。

-1） 單一方法的檢視，可直接使用類檢視的文件字串，如

class
booklistview(generics.listapiview):
"""返回所有圖書資訊.
"""    -2)包含多個方法的檢視，在類檢視的文件字串中，分開方法定義，如
class
booklistcreateview(generics.listcreateapiview):
"""get:
返回所有圖書資訊.
post:
新建圖書.
"""    -3)對於檢視集viewset，仍在類檢視的文件字串中封開定義，但是應使用action名稱區分，如
class
bookinfoviewset(mixins.listmodelmixin, mixins.retrievemodelmixin, genericviewset):
"""list:
返回圖書列表資料
retrieve:
返回圖書詳情資料
latest:
返回最新的圖書資料
read:
修改圖書的閱讀量
"""

1、遇到報錯attributeerror: 'autoschema' object has no attribute 'get_link'

解決方法：在settings中配置

rest_framework =

2、檢視集viewset中的retrieve名稱，在介面文件**中叫做read()

3、引數的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 =
}

使用方法：

1、安裝django-rest-swagger

pip install django-rest-swagger

2、在專案配置檔案settings中註冊django-rest-swagger應用

'django.contrib.admin',

....

'rest_framework_swagger',

]3、檢視類，跟coreapi庫得操作一樣，對方法進行注釋

4、路由配置：

'''

swagger使用方法：
1、匯入輔助函式get_schema_view
2、從swagger匯入兩個類swaggeruirenderer,openapirenderer
3、利用輔助函式匯入兩個類
'''from rest_framework.schemas import
get_schema_view
from rest_framework_swagger.renderers import
swaggeruirenderer,openapirenderer
schema_view=get_schema_view(title='
api介面文件
',renderer_classes=[swaggeruirenderer,openapirenderer])
urlpatterns =[
url(r
'^admin/
', admin.site.urls),
url(
'swagger/
',schema_view)
]

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 輸出...

API介面文件 自動生成

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