如何在Spring Boot 中整合Swagger 3 和Knife4j

本文介绍如何在 Spring Boot 中集成 Swagger 3 和 Knife4j，以生成 API 文档并提供交互式用户界面。通过使用 Swagger3BootStarter 依赖项，你可以为控制器方法添加注解，例如 @ApiOperation 和 @ApiImplicitParam，以便在 Swagger 文档中描述 API。此外，通过使用 Knife4j 微服务 Spring Boot 启动器，可以为 Swagger UI 提供更美观的 UI。

springboot集成swagger3

swagger3的springboot启动器jar包

    io.springfox
    springfox-boot-starter
    3.0.0

注意：当前SpringBoot版本为2.5.6，Swagger3.0目前无法完全兼容SpringBoot2.6.x！

编写TestController代码

@RestController
@RequestMapping("test")
public class TestController {
    @GetMapping
    public Map get(@RequestParam String id) {
        Map r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @PostMapping
    public Map post() {
        Map r = new HashMap<>(1);
        r.put("code", 200);
        return r;
    }
    @PutMapping
    public Map put(String id) {
        Map r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @DeleteMapping
    public Map delete(String id) {
        Map r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }
}

创建Swagger3Configuration

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    private static final String VERSION = "0.0.1";
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .groupName("分组名称")
                .apiInfo(apiInfo())
                .select()
                //要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置标题
                .title("文档标题")
                //联系人
                .contact(contact())
                //描述
                .description("xxx文档")
                //服务
                .termsOfServiceUrl("https://spring.io/")
                //许可证
                .license("Apache 2.0")
                .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
                .version(VERSION)
                .build();
    }
    private Contact contact (){
        return new Contact("SpringBoot", "https://spring.io/", "email");
    }
}

对接口进行注解

swagger中常用的注解

接口基本使用

1.新建一个用户实体类

@ApiModel("用户")
@Data
public class User {
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;
}

2.给TestController添加注解

@Api(tags = "测试接口")
@RestController
@RequestMapping("test")
public class TestController {
    @ApiOperation("get请求")
    @GetMapping
    @ApiImplicitParam(name = "id", value = "测试用id", dataTypeClass = String.class)
    public Map get(@RequestParam String id) {
        Map r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @ApiOperation("post请求")
    @PostMapping
    public Map post(@RequestBody User user) {
        Map r = new HashMap<>(1);
        r.put("code", 200);
        return r;
    }

    @ApiOperation("put请求")
    @PutMapping
    @ApiImplicitParam(name = "id", value = "put请求id", dataTypeClass = String.class)
    public Map put(String id) {
        Map r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @ApiOperation("delete请求")
    @DeleteMapping
    @ApiImplicitParam(name = "id", value = "delete请求id", dataTypeClass = String.class)
    public Map delete(String id) {
        Map r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }
}

运行结果

集成更好的UI-knife4j

maven

   com.github.xiaoymin
   knife4j-micro-spring-boot-starter
   3.0.3

启动器

在SwaggerConfig类上添加**@EnableKnife4j**

@Configuration
@EnableOpenApi
@EnableKnife4j
public class SwaggerConfig

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于文章的相关知识，也可关注golang学习网公众号。