SpringMVC和Swagger整合方法_Java教程

SpringMVC和Swagger整合方法

2020-12-12 16:37pinkylam Java教程

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。下面通过本文给大家分享SpringMVC和Swagger整合方法，感兴趣的朋友一起看看吧

描述

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。

配置

1、引入相关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>

2、创建java配置类

									@Configuration

									@EnableSwagger2

									public 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();

									  }

									}

3、编写接口文档测试

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

									}