使用SpringFox 3生成Swagger文档-CRMEB社区

使用SpringFox 3生成Swagger文档

管理

编辑

删除

SpringFox 3.0.0 的版本，有很多亮点，比如：

Spring 5，Webflux 支持（仅请求映射支持，尚不支持功能端点）
Spring Integration 支持
Spring Boot 支持 springfox-boot-starter 依赖性（零配置，自动配置支持）
具有自动完成功能的文档化配置属性
更好的规范兼容性
支持 OpenApi 3.0.3
几乎零依赖性（唯一需要的库是 spring-plugin、pswagger-core）
现有的 swagger2 注释将继续有效，并丰富 open API 3.0 规范

以上亮点比较突出的有：Webflux的支持、对OpenApi 3的支持，以及对Swagger 2的兼容。

为了更清楚的展示SpringFox 3.0.0 的优势，我们通过一个程序实验来更直观的来了解一下！

第一步：创建一个Spring Boot项目

第二步：pom.xml中添加依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
<dependency>

现在简洁了不少，一个依赖搞定！

第三步：应用主类增加注解@EnableOpenApi。

@EnableOpenApi
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

第四步：配置一些接口例子，比如：

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

    @ApiOperation("创建用户")
    @PostMapping("/users")
    public User create(@RequestBody @Valid User user) {
        return user;
    }

    @ApiOperation("用户详情")
    @GetMapping("/users/{id}")
    public User findById(@PathVariable Long id) {
        return new User("bbb", 21, "上海", "aaa@bbb.com");
    }

    @ApiOperation("用户列表")
    @GetMapping("/users")
    public List<User> list(@ApiParam("查看第几页") @RequestParam int pageIndex,
                           @ApiParam("每页多少条") @RequestParam int pageSize) {
        List<User> result = new ArrayList<>();
        result.add(new User("aaa", 50, "北京", "aaa@ccc.com"));
        result.add(new User("bbb", 21, "广州", "aaa@ddd.com"));
        return result;
    }

    @ApiIgnore
    @DeleteMapping("/users/{id}")
    public String deleteById(@PathVariable Long id) {
        return "delete user : " + id;
    }

}

@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel("用户基本信息")
public class User {

    @ApiModelProperty("姓名")
    @Size(max = 20)
    private String name;
    @ApiModelProperty("年龄")
    @Max(150)
    @Min(1)
    private Integer age;
    @NotNull
    private String address;
    @Pattern(regexp = "^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$")
    private String email;

}

第五步：启动应用！访问swagger页面：http://localhost:8080/swagger-ui/index.html

注意：

SpringFox 3.0.0的更新，移除了原来默认的swagger页面路径：http://host/context-path/swagger-ui.html，新增了两个可访问路径：http://host/context-path/swagger-ui/index.html和http://host/context-path/swagger-ui/
通过调整日志级别，还可以看到新版本的swagger文档接口也有新增，除了以前老版本的文档接口/v2/api-docs之外，还多了一个新版本的/v3/api-docs接口。

注：本文转载自“程序猿DD”，如有侵权，请联系删除！