個(gè)性化設(shè)置

2019-05-30 20:54 更新

個(gè)性化設(shè)置功能是SwaggerBootstrapUi針對(duì)本身Ui特點(diǎn)提供的個(gè)性化設(shè)置功能,主要包括:

  • 開(kāi)啟請(qǐng)求參數(shù)緩存
  • 菜單Api地址顯示
  • 分組tag顯示description說(shuō)明屬性
  • 開(kāi)啟RequestMapping接口類型重復(fù)地址過(guò)濾
  • 開(kāi)啟SwaggerBootstrapUi增強(qiáng)功能.

功能目錄:文檔管理 -> 個(gè)性化設(shè)置

開(kāi)啟請(qǐng)求參數(shù)緩存

此功能在在線調(diào)試時(shí)可見(jiàn)效果,當(dāng)針對(duì)每個(gè)接口點(diǎn)擊發(fā)送調(diào)試查看后,后面打開(kāi)該接口再調(diào)試時(shí),默認(rèn)為保留上一次發(fā)送的接口參數(shù)信息

如果不想開(kāi)啟此緩存,不勾選此項(xiàng)即可.默認(rèn)為true,即開(kāi)啟狀態(tài)

菜單Api地址顯示

菜單Api地址顯示是在左側(cè)菜單不顯示api地址信息,默認(rèn)為false,即不顯示,默認(rèn)效果如下圖

如果需要左側(cè)菜單欄顯示接口地址,則勾選此項(xiàng)接口,顯示效果圖如下:

分組tag顯示description說(shuō)明屬性

tag是否顯示代碼中的description屬性,默認(rèn)為false,及不顯示,如果勾選顯示description屬性,效果圖如下:

開(kāi)啟RequestMapping接口類型重復(fù)地址過(guò)濾

針對(duì)后端RequestMapping注解類型的接口,如果開(kāi)發(fā)者沒(méi)有指定接口類型,默認(rèn)使用Swagger會(huì)生成七個(gè)不同類型的接口地址,效果圖如下:

再某些情況下,開(kāi)發(fā)者可能需要過(guò)濾,簡(jiǎn)化重復(fù)的接口文檔,此時(shí),開(kāi)發(fā)者通過(guò)勾選此選項(xiàng),并在后面選擇顯示接口類型的選項(xiàng),SwaggerBootstrapUi會(huì)根據(jù)此選項(xiàng)自動(dòng)過(guò)濾

例如勾選,然后默認(rèn)顯示Post類型,則效果如下:

此項(xiàng)默認(rèn)為false,即不開(kāi)啟此項(xiàng)(不過(guò)濾).

開(kāi)啟SwaggerBootstrapUi增強(qiáng)功能

開(kāi)啟此項(xiàng)后,可使用SwaggerBootstrapUi的增強(qiáng)功能,關(guān)于增強(qiáng)功能,可參考增強(qiáng)功能章節(jié)介紹說(shuō)明

以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)