個(gè)性化配置快速訪問(wèn)參數(shù)說(shuō)明

2019-05-30 20:54 更新

1.9.2版本中,新增了可以通過(guò)參數(shù)來(lái)快速設(shè)置個(gè)性化配置的功能

使用場(chǎng)景:A:后端工程師 B:前端開(kāi)發(fā)工程師

在1.9.2版本之前

A:我已經(jīng)完成了接口的開(kāi)發(fā),也已經(jīng)開(kāi)啟了SwaggerBootstrapUi的增強(qiáng)功能,并且在本地聯(lián)調(diào)測(cè)試通過(guò),可以發(fā)給B了


B:收到文檔地址,http://ip:port/doc.html


A:B,你首先打開(kāi)文檔管理 -> 個(gè)性化配置  開(kāi)啟SwaggerBootstrapUi的增強(qiáng)功能,可以排序,接口更清晰呀


B:好的~~!!(PS:就不能直接給弄好嗎? o(╥﹏╥)o)

通過(guò)以上一個(gè)場(chǎng)景,我想大多數(shù)開(kāi)發(fā)同學(xué)都覺(jué)得很麻煩~~還需要前端的開(kāi)發(fā)一頓操作,就不能直接給弄好嗎? o(╥﹏╥)o

自1.9.2版本之后

為解決以上的問(wèn)題,自1.9.2版本后,加入了通過(guò)瀏覽器參數(shù)來(lái)快速配置個(gè)性化配置的功能,前端開(kāi)發(fā)無(wú)需關(guān)注文檔排序、是否開(kāi)啟緩存等操作,只要后端覺(jué)得該個(gè)性化功能合理,直接通過(guò)地址發(fā)給前端即可

界面如下:

后端同學(xué)自測(cè)后,將配置好的個(gè)性化配置功能保存,通過(guò)復(fù)制接口地址即可分享給前端同學(xué),前端同學(xué)就可以不用操作任何配置了,直接對(duì)接接口即可.

個(gè)性化配置參數(shù)說(shuō)明

  • i18n國(guó)際化支持:lang=en lang可選擇:中文(zh)、English(en)

  • 開(kāi)啟請(qǐng)求參數(shù)緩存:cache=1

  • 菜單Api地址顯示: showMenuApi=1

  • 分組tag顯示dsecription說(shuō)明屬性: showDes=1

  • 開(kāi)啟RequestMapping接口過(guò)濾,默認(rèn)只顯示: filterApi=1 filterApiType=post

  • 開(kāi)啟緩存已打開(kāi)的api文檔:cacheApi=1

  • 啟用SwaggerBootstrapUi提供的增強(qiáng)功能:plus=1
以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

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

編程獅公眾號(hào)