java开发之Swagger集成

发表于 | 分类于 | 阅读
字数 261

本文介绍了swagger3.0集成，并生成api文档

一.pom中添加spring-boot-starter-mail依赖

依赖如下：

1
2
3
4
5
6
<!--swagger api文档-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

二.如果springboot版本是2.6的版本，和swagger的版本有冲突，在properties文件中添加以下配置

1
spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

三.添加测试类类和测试接口

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
@RestController
@Api(tags = "API测试接口")
public class InfoController {
    @ApiOperation("增加操作")
    @PostMapping(value = "/inset")
    public void insert() {
        System.out.println("增加操作");
    }
    @ApiOperation("查询操作")
    @GetMapping(value = "/select")
    public void  select() {
        System.out.println("查询操作");
    }
    @ApiOperation("删除操作")
    @PostMapping(value = "/delete")
    public void delete() {
        System.out.println("删除操作");
    }
    @ApiOperation("更改操作")
    @PostMapping(value = "/update")
    public void update() {
        System.out.println("更改操作");
    }
}

四.添加swagger配置类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
@Configuration
public class Swagger2Configuration {
    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .build();
    }
    // API基础信息（Swagger默认页面的信息）
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger3接口文档")
                .build();
    }
}

五.结果

访问swagger地址：http://localhost:58083/swagger-ui/index.html

swagger.png

如果是8080端口：http://localhost:8080/swagger-ui/index.html