Swagger2的使用

第一步:引入相關jar包:

<dependency>

????<groupId>io.springfox</groupId>

????<artifactId>springfox-swagger2</artifactId>

????<version>2.4.0</version>

?</dependency>

<dependency>

????<groupId>io.springfox</groupId>

????<artifactId>springfox-swagger-ui</artifactId>

????<version>2.4.0</version>

</dependency>

第二步:編寫swagger2的配置文件胰耗,這里可以配置swagger2的一些基本的內容凸椿,比如掃描的包等等

@Configuration

@EnableSwagger2

public class Swagger2 {

????/**

? ? * @Description:swagger2的配置文件趾代,這里可以配置swagger2的一些基本的內容板惑,比如掃描的包等等

? ? */

? ? @Bean

? ? public Docket createRestApi() {

????????// 為swagger添加header參數可供輸入

? ? ? ? ParameterBuilder userTokenHeader =new ParameterBuilder();

????????ParameterBuilder userIdHeader =new ParameterBuilder();

????????List pars =new ArrayList();

????????userTokenHeader.name("headerUserToken").description("userToken")

????????.modelRef(new ModelRef("string")).parameterType("header")

????????.required(false).build();

????????userIdHeader.name("headerUserId").description("userId")

????????.modelRef(new ModelRef("string")).parameterType("header")

????????.required(false).build();

????????pars.add(userTokenHeader.build());

????????pars.add(userIdHeader.build());

????????return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()

????????.apis(RequestHandlerSelectors.basePackage("com.example.demo.Controller"))

????????.paths(PathSelectors.any()).build()

????????.globalOperationParameters(pars);

????}

????/**

? ? * @Description: 構建 api文檔的信息

? ? */

? ? private ApiInfo apiInfo() {

????????return new ApiInfoBuilder()

????????// 設置頁面標題

? ? ? ? ? ? ? ? .title("使用swagger2構建短視頻后端api接口文檔")

????????// 設置聯系人

? ? ? ?.contact(new Contact("imooc-風間影月","http://www.imooc.com","imooc@163.com"))

????????// 描述

? ? ? ?.description("歡迎訪問短視頻接口文檔东羹,這里是描述信息")

????????// 定義版本號

? ? ? ? .version("1.0").build();

????}

}

第三步:測試一下:

@RestController

@Api(value ="aaa", tags = {"這是玩的"})

public class DemoController {

????@ApiOperation(value ="方法", notes ="這是aa方法")

????@PostMapping("/aa")

????public Object bbb() {

????????return "aaaa";

}

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末趁舀,一起剝皮案震驚了整個濱河市早龟,隨后出現的幾起案子妻柒,更是在濱河造成了極大的恐慌扛拨,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,198評論 6 514
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件蛤奢,死亡現場離奇詭異鬼癣,居然都是意外死亡,警方通過查閱死者的電腦和手機啤贩,發(fā)現死者居然都...
    沈念sama閱讀 94,334評論 3 398
  • 文/潘曉璐 我一進店門待秃,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人痹屹,你說我怎么就攤上這事章郁。” “怎么了?”我有些...
    開封第一講書人閱讀 167,643評論 0 360
  • 文/不壞的土叔 我叫張陵暖庄,是天一觀的道長聊替。 經常有香客問我,道長培廓,這世上最難降的妖魔是什么惹悄? 我笑而不...
    開封第一講書人閱讀 59,495評論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮肩钠,結果婚禮上泣港,老公的妹妹穿的比我還像新娘。我一直安慰自己价匠,他們只是感情好当纱,可當我...
    茶點故事閱讀 68,502評論 6 397
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著踩窖,像睡著了一般坡氯。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上洋腮,一...
    開封第一講書人閱讀 52,156評論 1 308
  • 那天箫柳,我揣著相機與錄音,去河邊找鬼徐矩。 笑死滞时,一個胖子當著我的面吹牛叁幢,可吹牛的內容都是我干的滤灯。 我是一名探鬼主播,決...
    沈念sama閱讀 40,743評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼曼玩,長吁一口氣:“原來是場噩夢啊……” “哼鳞骤!你這毒婦竟也來了?” 一聲冷哼從身側響起黍判,我...
    開封第一講書人閱讀 39,659評論 0 276
  • 序言:老撾萬榮一對情侶失蹤豫尽,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后顷帖,有當地人在樹林里發(fā)現了一具尸體美旧,經...
    沈念sama閱讀 46,200評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 38,282評論 3 340
  • 正文 我和宋清朗相戀三年贬墩,在試婚紗的時候發(fā)現自己被綠了榴嗅。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,424評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡陶舞,死狀恐怖嗽测,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情肿孵,我是刑警寧澤唠粥,帶...
    沈念sama閱讀 36,107評論 5 349
  • 正文 年R本政府宣布疏魏,位于F島的核電站,受9級特大地震影響晤愧,放射性物質發(fā)生泄漏大莫。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,789評論 3 333
  • 文/蒙蒙 一官份、第九天 我趴在偏房一處隱蔽的房頂上張望葵硕。 院中可真熱鬧,春花似錦贯吓、人聲如沸懈凹。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,264評論 0 23
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽介评。三九已至,卻和暖如春爬舰,著一層夾襖步出監(jiān)牢的瞬間们陆,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,390評論 1 271
  • 我被黑心中介騙來泰國打工情屹, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留坪仇,地道東北人。 一個月前我還...
    沈念sama閱讀 48,798評論 3 376
  • 正文 我出身青樓垃你,卻偏偏與公主長得像椅文,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子惜颇,可洞房花燭夜當晚...
    茶點故事閱讀 45,435評論 2 359

推薦閱讀更多精彩內容