這篇文章主要介紹了Spring Boot如何集成Swagger2項目，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

創(chuàng)新互聯(lián)堅持“要么做到，要么別承諾”的工作理念，服務(wù)領(lǐng)域包括：網(wǎng)站設(shè)計制作、成都網(wǎng)站制作、企業(yè)官網(wǎng)、英文網(wǎng)站、手機(jī)端網(wǎng)站、網(wǎng)站推廣等服務(wù)，滿足客戶于互聯(lián)網(wǎng)時代的固鎮(zhèn)網(wǎng)站設(shè)計、移動媒體設(shè)計的需求，幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡(luò)建設(shè)合作伙伴！

一、Swagger簡介

　　在日常的工作中，我們往往需要給前端（WEB端、IOS、Android）或者第三方提供接口，這個時候我們就需要給他們提供一份詳細(xì)的API說明文檔。但維護(hù)一份詳細(xì)的文檔可不是一件簡單的事情。首先，編寫一份詳細(xì)的文檔本身就是一件很費(fèi)時費(fèi)力的事情，另一方面，由于代碼和文檔是分離的，所以很容易導(dǎo)致文檔和代碼的不一致。這篇文章我們就來分享一種API文檔維護(hù)的方式，即通過Swagger來自動生成Restuful API文檔。

　　那什么是Swagger？我們可以直接看下官方的描述：

THE WORLD'S MOST POPULAR API TOOLING
Swagger is the world's largest framework of API developer tools for the OpenAPI Specification(OAS),
enabling development across the entire API lifecycle, from design and documentation, to test and deployment.

　　這段話首先告訴大家Swagger是世界上最流行的API工具，并且Swagger的目的是支撐整個API生命周期的開發(fā)，包括設(shè)計、文檔以及測試和部署。這篇文章中我們會用到Swagger的文檔管理和測試功能。

　　對Swagger的作用有了基本的認(rèn)識后，我們現(xiàn)在來看看怎么使用。

二、Swagger與Spring boot集成

　　第一步：引入對應(yīng)jar包：

  io.springfox
  springfox-swagger2
  2.6.0


  io.springfox
  springfox-swagger-ui
  2.6.0

　　第二步，基本信息配置：

@Configuration
@EnableSwagger2
public class Swagger2Config {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.pandy.blog.rest"))
        .paths(PathSelectors.regex("/rest/.*"))
        .build();
  }
 
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Blog系統(tǒng)Restful API")
        .description("Blog系統(tǒng)Restful API")
        .termsOfServiceUrl("http://127.0.0.1:8080/")
        .contact("liuxiaopeng")
        .version("1.0")
        .build();
  }
}

　　基礎(chǔ)的配置是對整個API文檔的描述以及一些全局性的配置，對所有接口起作用。這里涉及到兩個注解：

　　@Configuration是表示這是一個配置類，是JDK自帶的注解，前面的文章中也已做過說明。

　　@EnableSwagger2的作用是啟用Swagger2相關(guān)功能。

　　在這個配置類里面我么實例化了一個Docket對象，這個對象主要包括三個方面的信息：

　　　?。?）整個API的描述信息，即ApiInfo對象包括的信息，這部分信息會在頁面上展示。

　　　?。?）指定生成API文檔的包名。

　　　?。?）指定生成API的路徑。按路徑生成API可支持四種模式，這個可以參考其源碼：

public class PathSelectors {
  private PathSelectors() {
    throw new UnsupportedOperationException();
  }
 
  public static Predicate any() {
    return Predicates.alwaysTrue();
  }
 
  public static Predicate none() {
    return Predicates.alwaysFalse();
  }
 
  public static Predicate regex(final String pathRegex) {
    return new Predicate() {
      public boolean apply(String input) {
        return input.matches(pathRegex);
      }
    };
  }
 
  public static Predicate ant(final String antPattern) {
    return new Predicate() {
      public boolean apply(String input) {
        AntPathMatcher matcher = new AntPathMatcher();
        return matcher.match(antPattern, input);
      }
    };
  }
}

　　從源碼可以看出，Swagger總共支持任何路徑都生成、任何路徑都不生成以及正則匹配和ant 模式匹配四種方式。大家可能比較熟悉的是前三種，最后一種ant匹配，如果不熟悉ant的話就直接忽略吧，前三種應(yīng)該足夠大家在日常工作中使用了。

　　有了上面的配置我們就可以看到效果了，我在com.pandy.blog.rest這個包下面有一個ArticleRestController這個類，源碼如下：

　　啟動Spring boot，然后訪問：http://127.0.0.1:8080/swagger-ui.html即可看到如下結(jié)果：

 　　這個頁面上可以看到，除了最后一個接口/test/{id}外，其他接口都生成對應(yīng)的文檔，最后一個接口因為不滿足我們配置的路徑——“/rest/.*”，所以沒有生成文檔。

　　我們還可以點進(jìn)去看一下每一個具體的接口，我們這里以“POST /rest/article”這個接口為例：

　　可以看到，Swagger為每一個接口都生成了返回結(jié)果和請求參數(shù)的示例，并且能直接通過下面的"try it out"進(jìn)行接口訪問，方面大家對接口進(jìn)行測試。整體上感覺Swagger還是很強(qiáng)大的，配置也比較簡單。

@RestController
public class ArticleRestController {
  @Autowired
  private ArticleService articleService;
  @RequestMapping(value = "/rest/article", method = POST, produces = "application/json")
  public WebResponse> saveArticle(@RequestBody Article article) {
    article.setUserId(1L);
    articleService.saveArticle(article);
    Map ret = new HashMap<>();
    ret.put("id", article.getId());
    WebResponse> response = WebResponse.getSuccessResponse(ret);
    return response;
  }
  @RequestMapping(value = "/rest/article/{id}", method = DELETE, produces = "application/json")
  public WebResponse deleteArticle(@PathVariable Long id) {
    Article article = articleService.getById(id);
    article.setStatus(-1);
    articleService.updateArticle(article);
    WebResponse