快捷導(dǎo)航

四步五分鐘Spring4快速集成Swagger

更新時(shí)間：2017年12月10日 13:34:20 作者：一個(gè)有點(diǎn)理想的猿

這篇文章主要為大家詳細(xì)介紹了四步、五分鐘Spring4快速集成Swagger的方法，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

如果你所在的公司的還沒有使用swagger甚至沒有聽說過swagger，趕快學(xué)習(xí)一下我的這篇博客吧，五分鐘速成，傻瓜式的集成，但就是這么簡(jiǎn)單的應(yīng)用一定會(huì)讓他們震驚到的。

首先對(duì)swagger做一個(gè)簡(jiǎn)介吧：swagger是后臺(tái)開發(fā)的神器，也是前后端交流的渠道。你可以用swagger做什么？首先，你以后基本可以告別單元測(cè)試了；其次，你不用再寫接口文檔了，也不需要寫完之后再去對(duì)文檔進(jìn)行維護(hù)了。swagger可以完全模擬http請(qǐng)求，入?yún)⒊鰠⒑蛯?shí)際情況差別幾乎為零。說了這些，直接來干貨吧！

集成四部曲：

第一步：導(dǎo)入兩個(gè)依賴吧，如果你不是maven項(xiàng)目，那你去找找jar包吧，記住只需要兩個(gè)，我看別的教程引入了七八個(gè)，簡(jiǎn)直是浪費(fèi)。

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

第二步：添加一個(gè)類（拷貝下面的即可，注意修改包名，地址）

/**
 * Swagger配置
 *
 * @author wq
 * @since 2017-05-16
 */
@EnableWebMvc
@EnableSwagger2
@Configuration
public class SwaggerConfig {

  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.z*.b*.c*.controller")) 
        // 注意修改此處的包名
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("接口列表 v1.1.0") // 任意，請(qǐng)稍微規(guī)范點(diǎn)
        .description("接口測(cè)試") // 任意，請(qǐng)稍微規(guī)范點(diǎn)
        .termsOfServiceUrl("http://url/swagger-ui.html") 
        // 將“url”換成自己的ip:port
       .contact("laowu") // 無所謂（這里是作者的別稱）
        .version("1.1.0")
        .build();
  }
}

第三步：在mvc的配置的文件中添加下面配置，可能你的文件也許是叫 dispatcher.xml?。ㄕ粘纯?，完全不需要修改）

<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/>
<mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>

第四步：在方法和參數(shù)上添加注解

方法上：
@ApiOperation(value = "教程", httpMethod = "POST", notes = "教程")
放在入?yún)⒅校?br /> @ApiParam(required = true, name = "test", value = "教程入?yún)?)

擔(dān)心有些朋友還不太明白，放張圖吧！

第五步：啟動(dòng)服務(wù)，然后在瀏覽器輸入：

http://ip:port/swagger-ui.html

出現(xiàn)下面的畫面就代表大功告成：

注意事項(xiàng)：如果你的項(xiàng)目中使用了攔截器，請(qǐng)將swagger資源放行（還是可以直接拷貝下面的配置，全部，不要懷疑v2）

<mvc:exclude-mapping path="/swagger*/**"></mvc:exclude-mapping>
<mvc:exclude-mapping path="/v2/**"></mvc:exclude-mapping>
<mvc:exclude-mapping path="/webjars/**"></mvc:exclude-mapping>

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: