為SpringBoot添加swagger2 Rest API文檔

一、為工程添加pom依賴:

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>

二鲤拿、代碼目錄:


image.png

三假褪、配置swagger具體代碼:

package com.we.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.basePackage("com.we.ui")).paths(PathSelectors.any())//設(shè)置掃描的包路徑
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("對(duì)外API接口").description("對(duì)外API接口") //設(shè)置描述之類的東西
                .termsOfServiceUrl("http://www.reibang.com/u/7fcaa9fcd2c1").contact("we").version("1.0").build();
    }
}

四、使用:
因?yàn)樵O(shè)置了要掃描的包路徑近顷,所以默認(rèn)開啟該路徑下的所有API文檔注解生音,


image.png

使用@ApiOperation為接口添加文檔注解
使用@ApiIgnore忽略該接口

啟動(dòng)服務(wù),訪問: http://localhost:8080/swagger-ui.html 可見到如下頁(yè)面:

image.png

完結(jié)窒升。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末缀遍,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子饱须,更是在濱河造成了極大的恐慌域醇,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,386評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件蓉媳,死亡現(xiàn)場(chǎng)離奇詭異譬挚,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)酪呻,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,142評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門减宣,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人玩荠,你說我怎么就攤上這事漆腌。” “怎么了姨蟋?”我有些...
    開封第一講書人閱讀 164,704評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵屉凯,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我眼溶,道長(zhǎng)悠砚,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,702評(píng)論 1 294
  • 正文 為了忘掉前任堂飞,我火速辦了婚禮灌旧,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘绰筛。我一直安慰自己枢泰,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,716評(píng)論 6 392
  • 文/花漫 我一把揭開白布铝噩。 她就那樣靜靜地躺著衡蚂,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上毛甲,一...
    開封第一講書人閱讀 51,573評(píng)論 1 305
  • 那天年叮,我揣著相機(jī)與錄音,去河邊找鬼玻募。 笑死只损,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的七咧。 我是一名探鬼主播跃惫,決...
    沈念sama閱讀 40,314評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼艾栋!你這毒婦竟也來了爆存?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,230評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤蝗砾,失蹤者是張志新(化名)和其女友劉穎终蒂,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體遥诉,經(jīng)...
    沈念sama閱讀 45,680評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,873評(píng)論 3 336
  • 正文 我和宋清朗相戀三年噪叙,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了矮锈。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,991評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡睁蕾,死狀恐怖苞笨,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情子眶,我是刑警寧澤瀑凝,帶...
    沈念sama閱讀 35,706評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站臭杰,受9級(jí)特大地震影響粤咪,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜渴杆,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,329評(píng)論 3 330
  • 文/蒙蒙 一寥枝、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧磁奖,春花似錦囊拜、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,910評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春蜜托,著一層夾襖步出監(jiān)牢的瞬間抄囚,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,038評(píng)論 1 270
  • 我被黑心中介騙來泰國(guó)打工盗冷, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留怠苔,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,158評(píng)論 3 370
  • 正文 我出身青樓仪糖,卻偏偏與公主長(zhǎng)得像柑司,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子锅劝,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,941評(píng)論 2 355