這篇文章將為大家詳細(xì)講解有關(guān)使用SpringMVC怎么對Swagger進(jìn)行整合，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關(guān)知識有一定的了解。

成都創(chuàng)新互聯(lián)公司從2013年成立，是專業(yè)互聯(lián)網(wǎng)技術(shù)服務(wù)公司，擁有項(xiàng)目成都網(wǎng)站建設(shè)、網(wǎng)站建設(shè)網(wǎng)站策劃，項(xiàng)目實(shí)施與項(xiàng)目整合能力。我們以讓每一個夢想脫穎而出為使命，1280元黃埔做網(wǎng)站,已為上家服務(wù),為黃埔各地企業(yè)和個人服務(wù),聯(lián)系電話:028-86922220

配置

1、引入相關(guān)jar包：

  io.springfox
  springfox-swagger2
  2.7.0


  io.springfox
  springfox-swagger-ui
  2.7.0

2、創(chuàng)建java配置類

@Configuration
@EnableSwagger2
public class Swagger2 {
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
         // 文檔標(biāo)題
        .title("wish")
        // 文檔描述
        .description("https://github.com/handexing").termsOfServiceUrl("https://github.com/handexing")
        .version("v1")
        .build();
  }
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        // 指定controller存放的目錄路徑
        .apis(RequestHandlerSelectors.basePackage("com.wish.controller"))
        .paths(PathSelectors.any())
        .build();
  }
}

3、編寫接口文檔測試

@RequestMapping(value = "testSawgger", method = RequestMethod.POST, produces = "application/json; charset=utf-8")
@ApiOperation(value = "測試swagger", httpMethod = "POST", notes = "testSawgger")
public ExecuteResult addUser(@ApiParam(value = "參數(shù)", required = true) Long id) {
  ExecuteResult result = new ExecuteResult();
  try {
    result.setSuccess(true);
  } catch (Exception e) {
    result.setSuccess(false);
  }
  return result;
}

說明：

@ApiOperation:用在方法之上

1、value: 表示接口名稱

2、notes: 表示接口詳細(xì)描述

3、httpMethod:表示接口請求方法類型

@ApiParam:用在方法參數(shù)上

1、required:表示參數(shù)是否必須傳

2、name:表示參數(shù)名稱

3、value:表示參數(shù)描述

關(guān)于使用SpringMVC怎么對Swagger進(jìn)行整合就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，可以學(xué)到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。