乐趣区

SpringBoot整合Swagger实战

jiezi

源码地址：https://github.com/laolunsi/spring-boot-examples

目前 SpringBoot 常被用于开发 Java Web 应用，特别是前后端分离项目。为方便前后端开发人员进行沟通，我们在 SpringBoot 引入了 Swagger。

Swagger 作用于接口，让接口数据可视化，尤其适用于 Restful APi

本节分两部分介绍，第一部分是 SpringBoot 引入 Swagger 的两种方式，第二部分是详细介绍在 Web 接口上应用 Swagger 的注解。

本篇文章使用 SpringBoot 2.1.10.RELEASE 和 springfox-swagger 2.9.2

一、SpringBoot 引入 Swagger 的两种方式

目前 SpringBoot 有两种使用 Swagger 的方式：

  1. 引入 swagger 原生依赖 springfox-swagger2 和springfox-swagger2-ui
  2. 引入国内 Spring4All 社区开发的依赖swagger-spring-boot-starter

Spring4All 出品的依赖采取配置文件的方式进行配置，而原生依赖是通过 java config 类来设置的。

1.1 原生配置 Swagger

maven 依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>

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

swagger 配置类：

/**
 * swagger2 配置类
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example"))
                .paths(PathSelectors.any())
                .build();}


    private ApiInfo apiInfo() {return new ApiInfoBuilder()
                .title("基于 Swagger 构建的 Rest API 文档")
                .description("更多请咨询服务开发者 eknown")
                .contact(new Contact("空夜", "http://www.eknown.cn", "eknown@163.com"))
                .termsOfServiceUrl("http://www.eknown.com")
                .version("1.0")
                .build();}
}

从这里可以看出 Swagger 的一个缺点：无法通过 SpringBoot 的配置文件进行配置，所以配置并不能灵活转变。

spring4all 社区出品的 swagger-spring-boot-starter 可以解决这个问题。

1.2 基于 spring4all 配置 swagger

Spring4All 社区的博主程序猿 DD 和小火两个人开发了 Spring Boot Starter Swagger，目前已经在 maven 官方仓库上线了。

选择第一个，引入该依赖：

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.9.0.RELEASE</version>
</dependency>

这种方式的 Swagger 配置是通过 application 配置文件进行的。下面给出一个示例：

server:
  port: 8106
swagger:
  base-path: /**
  base-package: 'com.example'
  title: 'spring-boot-swagger-demo'
  description: '基于 Swagger 构建的 SpringBoot RESTApi 文档'
  version: '1.0'
  contact:
    name: '空夜'
    url: 'http://www.eknown.cn'
    email: 'eknown@163.com'

二、应用 Swagger 构建接口可视化

2.1 Controller 类添加 Swagger 注解

下面给一个简单的示例：

@Api(tags = "用户管理")
@RestController
@RequestMapping(value = "user")
public class UserController {

    // 模拟数据库存储的用户
    private static Map<Integer, User> userMap;

    static {userMap = new ConcurrentHashMap<>();
        User user = new User(0, "admin", true, new Date());
        userMap.put(user.getId(), user);
    }

    @ApiOperation("列表查询")
    @GetMapping(value = "")
    public List<User> list() {return new ArrayList<>(userMap.values());
    }

    @ApiOperation(value = "获取用户详细信息", notes = "路径参数 ID")
    @GetMapping(value = "{id}")
    public User detail(@PathVariable Integer id) {return userMap.get(id);
    }

    @ApiOperation(value = "新增或更新用户信息", notes = "insert 和 update 共用"
            , response = User.class)
    @PostMapping(value = "")
    public User add(@RequestBody User user) {if (user == null || user.getId() == null || !StringUtils.isEmpty(user.getName())
                || userMap.containsKey(user.getId())) {return null;}

        user.setUpdateTime(new Date());
        userMap.put(user.getId(), user);
        return user;
    }


    @ApiOperation(value = "删除用户")
    @DeleteMapping(value = "{id}")
    public Boolean delete(@ApiParam(name = "用户 ID", required = true, example = "100") @PathVariable Integer id) {if (userMap.containsKey(id)) {userMap.remove(id);
            return true;
        }

        return false;
    }

}

2.2 参数实体类添加 Swagger 注解

实体类也需要添加一些注解，以便前端开发人员确定参数的意义、类型、示例等。

@ApiModel(description = "用户类")
public class User {@ApiModelProperty(value = "ID", example = "100")
    private Integer id;

    @ApiModelProperty(value = "姓名", example = "laolunsi")
    private String name;

    @ApiModelProperty(value = "是否启用", example = "1")
    private Boolean enable;

    @ApiModelProperty("更新时间")
    private Date updateTime;

    public User(Integer id, String name, Boolean enable, Date updateTime) {
        this.id = id;
        this.name = name;
        this.enable = enable;
        this.updateTime = updateTime;
    }

    // ... ignore getter and setter methods
}

2.3 测试

启动项目，访问 http://localhost:port/swagger-ui.html

如果存在 server.servlet.context-path 配置，那么访问地址是 http://localhost:port/context-path/swagger-ui.html

这样，接口就一目了然了，swagger 还支持在线测试接口，与 postman 的作用类似。

好，到目前为止，我们已经成功在 SpringBoot 项目中整合了 Swagger，这样前后端开发对接就有了标准！

交流学习

我的个人网站：http://www.eknown.cn

Git 仓库地址：https://github.com/laolunsi

另外也欢迎大家关注我的公众号：猿生物语，一起学习 Java/SpringBoot/SpringCloud 技术。

退出移动版