Django restful framework中自動(dòng)生成API文檔

?

一、Swagger概述

1.引言

當(dāng)接口開(kāi)發(fā)完成，緊接著需要編寫(xiě)接口文檔。傳統(tǒng)的接口文檔使用Word編寫(xiě)，or一些接口文檔管理平臺(tái)進(jìn)行編寫(xiě)，但此類(lèi)接口文檔維護(hù)更新比較麻煩，每次接口有變更，需要手動(dòng)修改接口文檔。為了改善這種情況，推薦使用Swagger來(lái)管理接口文檔，實(shí)現(xiàn)接口文檔的自動(dòng)更新。也推薦淘寶后端寫(xiě)的RAP2在線(xiàn)接口文檔。

2.Swagger簡(jiǎn)介

Swagger：是一個(gè)規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化RESTful風(fēng)格的Web服務(wù)。總體目標(biāo)是使客戶(hù)端和文件系統(tǒng)源代碼作為服務(wù)器以同樣的速度來(lái)更新。當(dāng)接口有變動(dòng)時(shí)，對(duì)應(yīng)的接口文檔也會(huì)自動(dòng)更新。

Swagger優(yōu)勢(shì)：
1）Swagger可生成一個(gè)具有互動(dòng)性的API控制臺(tái)，開(kāi)發(fā)者可快速學(xué)習(xí)和嘗試API
2）Swagger可生成客戶(hù)端SDK代碼，用于不同平臺(tái)上（Java、Python...）的實(shí)現(xiàn)
3）Swagger文件可在許多不同的平臺(tái)上從代碼注釋中自動(dòng)生成
4）Swagger有一個(gè)強(qiáng)大的社區(qū)，里面有許多強(qiáng)悍的貢獻(xiàn)者

?

二、Swagger安裝和配置

參考官網(wǎng)：https://github.com/marcgibbons/django-rest-swagger

自動(dòng)生成api文檔（不管是函數(shù)視圖還是類(lèi)視圖都能顯示）

1.安裝rest_framework_swagger庫(kù)

pip install django-rest-swagger

?

?

2.在項(xiàng)目下的 urls.py 中加入如下：

from rest_framework_swagger.views import get_swagger_viewschema_view = get_swagger_view(title='API文檔') urlpatterns += [path(r'docs/', schema_view), ]

?

?

3.在創(chuàng)建的django項(xiàng)目下的settings中加入如下：

INSTALLED_APPS = ['rest_framework_swagger',]REST_FRAMEWORK = {'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema' }

?

?

4、生成的api文檔界面如下：

可以通過(guò)定義注釋格式來(lái)設(shè)置接口備注信息

?

?

5、DRF訪(fǎng)問(wèn)接口自帶的界面如下：

?

?

更多分享以及Python之基礎(chǔ)知識(shí)大全關(guān)注公眾號(hào)【劉旺學(xué)長(zhǎng)】

總結(jié)

以上是生活随笔為你收集整理的【接口文档】Django restful framework中自动生成API文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。