Springboot整合Swagger+mybatis-plus

cccy001

已于 2023-08-21 13:57:14 修改

阅读量375

点赞数 2

文章标签： spring boot mybatis java

于 2023-08-21 12:34:56 首次发布

本文链接：https://blog.youkuaiyun.com/qq_56923228/article/details/132405853

版权

本文档详细介绍了如何将Swagger2与Mybatis-Plus整合到Springboot项目中，以实现强大的API接口管理和简化数据库操作。Swagger2提供接口文档，方便API说明和测试；Mybatis-Plus作为Mybatis的增强工具，简化了CRUD操作和条件构造。整合步骤包括Swagger的依赖引入、配置，以及Mybatis-Plus的使用介绍和配置。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.springboot整合swagger接口文档

1.1什么是swagger2

1.2 为什么需要使用swagger2的api文档

1.3如何使用swagger2

2.springboot整合mybatis-plus

2.1 mp的简介

2.2 如何使用

1.springboot整合swagger接口文档

1.1什么是swagger2

它就是可以api接口，它可以对你书写的接口进行说明。并以文档的形式存在。、

1.2 为什么需要使用swagger2的api文档

1.3如何使用swagger2

(1)引用swagger的依赖

        <!--引入swagger2依赖-->
        <dependency>
            <groupId>io.github.jianzhichun</groupId>
            <artifactId>spring-boot-starter-swagger2</artifactId>
            <version>0.0.1</version>
        </dependency>
        <!--图形化依赖-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

(2)配置swagger的信息

@Configuration //表示类似于配置文件
public class SwaggerConfig {
    @Bean //加在方法上，表示把方法的返回结果交于spring容器来管理对象，docket里面封装了接口文档的信息
    public Docket docket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("qy168")
                .apiInfo(getInfo())
                .select()
                //只为com.aaa.controller包下的类生成接口文档
                .apis(RequestHandlerSelectors.basePackage("com.aaa.controller"))
                .build();
        return docket;
    }
    private ApiInfo getInfo(){
        Contact DEFAULT_CONTACT = new Contact("于清晨","http://www/baidu.com","111@qq.com");
        ApiInfo apiInfo=new ApiInfo("QY168班级","学生管理系统API文档","1.0","http://localhost:8081/doc.html",
                DEFAULT_CONTACT,"11网络科技有限公司","about:blank");
        return apiInfo;
    }
}

(3)使用swagger的注解

@Api：接口类的说明加在controller类上

@ApiOperation: 接口方法的说明。加在controller方法上

@ApiImplicitParams: 接口方法的所有参数的说明.

@ApiImplicitParam:单个参数的说明

--name: 参数名

--value: 参数的说明

--require: 是否为必须的

--dataType: 参数类型说明 int string

@ApiModel: 实体类的说明

@ApiModelProperty: 单个参数的说明

(4）启动工程并访问swagger接口文档的路径

http://ip:port/swagger-ui.html