springboot集成swagger3与knife4j的详细代码

更新时间：2022年08月16日 16:06:20 作者：卑微小钟

这篇文章主要介绍了springboot集成swagger3与knife4j，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

springboot集成swagger3

swagger3的springboot启动器jar包

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

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

编写TestController代码

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

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

    @DeleteMapping
    public Map<String, Object> delete(String id) {
        Map<String, Object> 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");
    }
}

运行演示

访问网址：http://127.0.0.1:8081/swagger-ui/index.html

对接口进行注解

swagger中常用的注解

注解	作用	使用位置
@Api	表示对类的说明常用参数	类
@ApiOperation	说明方法的用途	方法
@ApiImplicitParams	里面可以包含多个@ApiImplicitParam	方法
@ApiImplicitParam	描述参数的用途	方法
@ApiModel	表示一个数据类的信息	类
@ApiModelProperty	描述数据类的属性	属性
@ApiIgnore	忽略某个字段使之不显示在文档中	属性

接口基本使用

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<String, Object> get(@RequestParam String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

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

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

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

运行结果

在这里插入图片描述

集成更好的UI-knife4j

maven

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-micro-spring-boot-starter</artifactId>
   <version>3.0.3</version>
</dependency>

启动器

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

@Configuration
@EnableOpenApi
@EnableKnife4j
public class SwaggerConfig

访问网站：http://127.0.0.1:8080/doc.html#/home

到此这篇关于springboot集成swagger3与knife4j的文章就介绍到这了,更多相关springboot集成swagger3内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java实现生成自定义时长的静音音频
这篇文章主要介绍了如何通过Java实现一个音频工具类，可以实现生成一段自定义时长(精确到毫秒)的wav音频。感兴趣的小伙伴可以了解一下
2022-01-01
两天没解决的问题chatgpt用了5秒搞定隐藏bug
这篇文章主要为大家描述了我用了两天没解决的问题chatgpt用了5秒搞定的全程介绍，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-04-04
详解Guava中EventBus的使用
EventBus是Guava的事件处理机制，是设计模式中观察者模式（生产/消费者编程模型）的优雅实现。本文就来和大家聊聊EventBus的使用，需要的可以参考一下
2022-12-12
Java Stream.reduce()用法详细解析
Stream API提供了丰富的中间函数,归并函数和终端函数,这些函数还支持并行化执行,下面这篇文章主要给大家介绍了关于Java Stream.reduce()用法的相关资料,需要的朋友可以参考下
2022-12-12
SpringBoot集成MyBatis的分页插件PageHelper实例代码
这篇文章主要介绍了SpringBoot集成MyBatis的分页插件PageHelper的相关操作，需要的朋友可以参考下
2017-08-08
10个Java解决内存溢出OOM的方法详解
在Java开发过程中,有效的内存管理是保证应用程序稳定性和性能的关键,不正确的内存使用可能导致内存泄露甚至是致命的OutOfMemoryError（OOM）,下面我们就来学习一下有哪些解决办法吧
2024-01-01
java 流操作对文件的分割和合并的实例详解
这篇文章主要介绍了java 流操作对文件的分割和合并的实例详解的相关资料,希望通过本文能帮助到大家，让大家理解掌握这部分内容，需要的朋友可以参考下
2017-10-10
java使用pdfbox操作pdf文件示例
有时候PDF中的文字无法复制，这可能是因为PDF文件加密了，不过使用PDFBox开源软件就可以把它读出来，下面是使用示例
2014-03-03
关于Springboot中JSCH的使用及说明
这篇文章主要介绍了关于Springboot中JSCH的使用及说明，具有很好的参考价值，希望对大家有所帮助。
2022-09-09
SpringBoot整合RabbitMQ实现延迟队列的示例详解
这篇文章主要为大家详细介绍了SpringBoot如何整合RabbitMQ实现延迟队列，文中的示例代码讲解详细，具有一定的学习价值，感兴趣的可以了解一下
2023-04-04