Spring系列整合Swagger

SpringMvc整合Swagger(spring版本在4.1.8以上膘滨,深深的痛)

1.先搭建好springmvc的環(huán)境
2.修改pom文件

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

    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.7.0</version>
    </dependency>

3.也需要引入jackson的包
4.定義一個swagger的配置類

@EnableWebMvc
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("jk.zmn.mvc.controller")) //要掃描的API(Controller)基礎包
                .paths(PathSelectors.any()) // and by paths
                .build();

    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口列表 v1.1.0") // 任意干旧,請稍微規(guī)范點
                .description("接口測試") // 任意蝠引,請稍微規(guī)范點
                .termsOfServiceUrl("http://localhost:8080/swagger-ui.html") // 將“url”換成自己的ip:port
                .contact("laowu") // 無所謂(這里是作者的別稱)
                .version("1.1.0")
                .build();
    }
}

5.修改springmvc的配置文件,放行一些靜態(tài)資源

  <mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
    <mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>
    <!--&lt;!&ndash; 添加掃描配置類 &ndash;&gt;-->
    <bean class="jk.zmn.mvc.config.SwaggerConfig" />

6.新建controller跋理,定義一些相關的文檔

@RestController
@RequestMapping("test")
@Api(value = "Test")
public class TestController {

    @RequestMapping("index")
    @ApiOperation(value = "進入首頁面")
    public String index(){
        return "index";
    }

}

7.訪問http://ip:端口/項目名/swagger-ui.html即可

SpringBoot整合swagger

1.新建springboot項目
2.引入swagger的jar包

<!-- Swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

3.定義swagger的配置類

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("jk.zmn.swaggerspringboot.controller")) //要掃描的API(Controller)基礎包
                .paths(PathSelectors.any()) // and by paths
                .build()
                .apiInfo(buildApiInf());
    }

    private ApiInfo buildApiInf() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2 UI構建API文檔")
                .contact("test")
                .version("1.0.0")
                .build();
    }
}

4.自定義controller生成文檔
5.訪問http://ip:端口/項目名/swagger-ui.html即可

?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市昨稼,隨后出現(xiàn)的幾起案子瞒瘸,更是在濱河造成了極大的恐慌,老刑警劉巖殖演,帶你破解...
    沈念sama閱讀 221,695評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件氧秘,死亡現(xiàn)場離奇詭異,居然都是意外死亡趴久,警方通過查閱死者的電腦和手機丸相,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,569評論 3 399
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來彼棍,“玉大人灭忠,你說我怎么就攤上這事∽叮” “怎么了弛作?”我有些...
    開封第一講書人閱讀 168,130評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長华匾。 經(jīng)常有香客問我映琳,道長,這世上最難降的妖魔是什么蜘拉? 我笑而不...
    開封第一講書人閱讀 59,648評論 1 297
  • 正文 為了忘掉前任萨西,我火速辦了婚禮,結果婚禮上旭旭,老公的妹妹穿的比我還像新娘谎脯。我一直安慰自己,他們只是感情好您机,可當我...
    茶點故事閱讀 68,655評論 6 397
  • 文/花漫 我一把揭開白布穿肄。 她就那樣靜靜地躺著,像睡著了一般际看。 火紅的嫁衣襯著肌膚如雪咸产。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,268評論 1 309
  • 那天仲闽,我揣著相機與錄音脑溢,去河邊找鬼。 笑死,一個胖子當著我的面吹牛屑彻,可吹牛的內(nèi)容都是我干的验庙。 我是一名探鬼主播,決...
    沈念sama閱讀 40,835評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼社牲,長吁一口氣:“原來是場噩夢啊……” “哼粪薛!你這毒婦竟也來了?” 一聲冷哼從身側響起搏恤,我...
    開封第一講書人閱讀 39,740評論 0 276
  • 序言:老撾萬榮一對情侶失蹤违寿,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后熟空,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體藤巢,經(jīng)...
    沈念sama閱讀 46,286評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,375評論 3 340
  • 正文 我和宋清朗相戀三年息罗,在試婚紗的時候發(fā)現(xiàn)自己被綠了掂咒。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,505評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡迈喉,死狀恐怖绍刮,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情弊添,我是刑警寧澤录淡,帶...
    沈念sama閱讀 36,185評論 5 350
  • 正文 年R本政府宣布捌木,位于F島的核電站油坝,受9級特大地震影響,放射性物質發(fā)生泄漏刨裆。R本人自食惡果不足惜澈圈,卻給世界環(huán)境...
    茶點故事閱讀 41,873評論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望帆啃。 院中可真熱鬧瞬女,春花似錦、人聲如沸努潘。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,357評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽疯坤。三九已至报慕,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間压怠,已是汗流浹背眠冈。 一陣腳步聲響...
    開封第一講書人閱讀 33,466評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留菌瘫,地道東北人蜗顽。 一個月前我還...
    沈念sama閱讀 48,921評論 3 376
  • 正文 我出身青樓布卡,卻偏偏與公主長得像,于是被迫代替她去往敵國和親雇盖。 傳聞我的和親對象是個殘疾皇子忿等,可洞房花燭夜當晚...
    茶點故事閱讀 45,515評論 2 359

推薦閱讀更多精彩內(nèi)容