swagger3 + knife4j實(shí)現(xiàn)優(yōu)雅接口文檔

swagger大家都不陌生倒堕,強(qiáng)大的接口文檔工具,最近出了swaager3版本爆价,馬上嘗鮮

knife4j功能強(qiáng)大垦巴,頁面更美觀,在線調(diào)試功能很喜歡铭段,不用再在postman手動(dòng)輸鏈接調(diào)試了


全局參數(shù)添加header

支持離線文檔下載


添加依賴?implementation"io.springfox:springfox-boot-starter:3.0.0? ?習(xí)慣用gradle

implementation"com.github.xiaoymin:knife4j-spring-boot-starter:3.0.1


新建配置文件SwaggerConfiguration

/**

* 基于Swagger生成API文檔

*

* @author qiuw

* *@EnableOpenApi:啟動(dòng)OpenApi的類骤宣; 之前是@EnableSwagger2

*/

@Configuration

@EnableOpenApi

@EnableKnife4j

@Import(BeanValidatorPluginsConfiguration.class)

public class SwaggerConfiguration {

@Bean

? ? public DocketcreateRestApi() {

return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo()).select()

.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))

.paths(PathSelectors.any())

.build();

? ? }

private ApiInfoapiInfo() {

return new ApiInfoBuilder()

.title("標(biāo)題")

.description("描述")

.contact(new Contact("聯(lián)系人", "www.xxx.com", "xxx@xxx.com"))

.version("1.0.0")

.build();

? ? }

}


就這么簡單,然后就是接口文檔編寫和之前的一樣


@Api??@ApiOperation? 等等就不再說了


原生swaager頁面訪問?http://localhost:8080//swagger-ui/index.html? 端口那些自己改

knife4j 訪問?http://localhost:8080/doc.html


給knife4j設(shè)置權(quán)限

在yml或properties配置文件加配置

# 接口文檔配置

knife4j:

enable:true? # 開啟權(quán)限驗(yàn)證

? basic:

enable:true

? ? username: eas# 登錄賬號(hào)

? ? password: eas# 登錄密碼

就實(shí)現(xiàn)攔截了序愚,官方文檔這塊還沒更新憔披,自己試出來的knife4j官網(wǎng)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市爸吮,隨后出現(xiàn)的幾起案子芬膝,更是在濱河造成了極大的恐慌,老刑警劉巖形娇,帶你破解...
    沈念sama閱讀 217,406評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件锰霜,死亡現(xiàn)場離奇詭異,居然都是意外死亡桐早,警方通過查閱死者的電腦和手機(jī)癣缅,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來哄酝,“玉大人友存,你說我怎么就攤上這事§牌撸” “怎么了爬立?”我有些...
    開封第一講書人閱讀 163,711評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長万哪。 經(jīng)常有香客問我侠驯,道長抡秆,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,380評(píng)論 1 293
  • 正文 為了忘掉前任吟策,我火速辦了婚禮儒士,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘檩坚。我一直安慰自己着撩,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,432評(píng)論 6 392
  • 文/花漫 我一把揭開白布匾委。 她就那樣靜靜地躺著拖叙,像睡著了一般。 火紅的嫁衣襯著肌膚如雪赂乐。 梳的紋絲不亂的頭發(fā)上薯鳍,一...
    開封第一講書人閱讀 51,301評(píng)論 1 301
  • 那天,我揣著相機(jī)與錄音挨措,去河邊找鬼挖滤。 笑死,一個(gè)胖子當(dāng)著我的面吹牛浅役,可吹牛的內(nèi)容都是我干的斩松。 我是一名探鬼主播,決...
    沈念sama閱讀 40,145評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼觉既,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼惧盹!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起奋救,我...
    開封第一講書人閱讀 39,008評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤岭参,失蹤者是張志新(化名)和其女友劉穎反惕,沒想到半個(gè)月后尝艘,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,443評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡姿染,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,649評(píng)論 3 334
  • 正文 我和宋清朗相戀三年背亥,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片悬赏。...
    茶點(diǎn)故事閱讀 39,795評(píng)論 1 347
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡狡汉,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出闽颇,到底是詐尸還是另有隱情盾戴,我是刑警寧澤,帶...
    沈念sama閱讀 35,501評(píng)論 5 345
  • 正文 年R本政府宣布兵多,位于F島的核電站尖啡,受9級(jí)特大地震影響橄仆,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜衅斩,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,119評(píng)論 3 328
  • 文/蒙蒙 一盆顾、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧畏梆,春花似錦您宪、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,731評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至溜畅,卻和暖如春揖铜,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背达皿。 一陣腳步聲響...
    開封第一講書人閱讀 32,865評(píng)論 1 269
  • 我被黑心中介騙來泰國打工天吓, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人峦椰。 一個(gè)月前我還...
    沈念sama閱讀 47,899評(píng)論 2 370
  • 正文 我出身青樓龄寞,卻偏偏與公主長得像,于是被迫代替她去往敵國和親汤功。 傳聞我的和親對(duì)象是個(gè)殘疾皇子物邑,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,724評(píng)論 2 354