個性化設置

2019-05-30 20:54 更新

個性化設置功能是SwaggerBootstrapUi針對本身Ui特點提供的個性化設置功能,主要包括:

  • 開啟請求參數(shù)緩存
  • 菜單Api地址顯示
  • 分組tag顯示description說明屬性
  • 開啟RequestMapping接口類型重復地址過濾
  • 開啟SwaggerBootstrapUi增強功能.

功能目錄:文檔管理 -> 個性化設置

開啟請求參數(shù)緩存

此功能在在線調試時可見效果,當針對每個接口點擊發(fā)送調試查看后,后面打開該接口再調試時,默認為保留上一次發(fā)送的接口參數(shù)信息

如果不想開啟此緩存,不勾選此項即可.默認為true,即開啟狀態(tài)

菜單Api地址顯示

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

如果需要左側菜單欄顯示接口地址,則勾選此項接口,顯示效果圖如下:

分組tag顯示description說明屬性

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

開啟RequestMapping接口類型重復地址過濾

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

再某些情況下,開發(fā)者可能需要過濾,簡化重復的接口文檔,此時,開發(fā)者通過勾選此選項,并在后面選擇顯示接口類型的選項,SwaggerBootstrapUi會根據(jù)此選項自動過濾

例如勾選,然后默認顯示Post類型,則效果如下:

此項默認為false,即不開啟此項(不過濾).

開啟SwaggerBootstrapUi增強功能

開啟此項后,可使用SwaggerBootstrapUi的增強功能,關于增強功能,可參考增強功能章節(jié)介紹說明

以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號