使用SpringMVC怎么对Swagger进行整合

这篇文章将为大家详细讲解有关使用springMVC怎么对swagger进行整合，文章内容质量较高，因此小编分享给大家做个参考，希望大家阅读完这篇文章后对相关知识有一定的了解。

配置

引入相关jar包：

<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>

创建java配置类

@Configuration@EnableSwagger2public class Swagger2 {  private apiInfo apiInfo() {    return new ApiInfoBuilder()         // 文档标题        .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();  }}

编写接口文档测试

@RequestMapping(value = "testSawgger", method = RequestMethod.POST, produces = "application/JSON; charset=utf-8")@ApiOperation(value = "测试swagger", httpMethod = "POST", notes = "testSawgger")public ExecuteResult<Boolean> addUser(@ApiParam(value = "参数", required = true) Long id) {  ExecuteResult<Boolean> result = new ExecuteResult<Boolean>();  try {    result.setSuccess(true);  } catch (Exception e) {    result.setSuccess(false);  }  return result;}

说明：

@ApiOperation:用在方法之上

value: 表示接口名称

notes: 表示接口详细描述

httpMethod:表示接口请求方法类型

@ApiParam:用在方法参数上

required:表示参数是否必须传

name:表示参数名称

value:表示参数描述

关于使用Springmvc怎么对Swagger进行整合就分享到这里了，希望以上内容可以对大家有一定的帮助，可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到。