springboot整合swagger接口文档与mybatis-plus

最新推荐文章于 2024-07-08 17:20:04 发布
最新推荐文章于 2024-07-08 17:20:04 发布
阅读量226 收藏 1
点赞数 1
文章标签： spring boot mybatis 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/future_n/article/details/132402897
版权

springboot整合swagger接口文档与mybatis-plus

1.整合swagger接口文档

接口文档的作用: 就是为了方便前后端的交互。

(1)导入swagger2依赖
localhost:8080/doc.html：打开路径

 <!--swagger的依赖引入-->
        <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配置类

package com.aaa.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerConfig {
    @Bean
    public Docket docket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("组名")
                //设置文档的信息
                .apiInfo(getInfo())
                .select()
                //指定未哪些包生成接口文档。
                .apis(RequestHandlerSelectors.basePackage("com.aaa.controller"))
                .build();
        return docket;
    }

    private ApiInfo getInfo(){
        Contact DEFAULT_CONTACT = new Contact("联系人姓名", "网址", "邮箱");
        ApiInfo apiInfo = new ApiInfo("学生管理系统API文档", "学生管理系统API文档", "2.0", "文档打开路径",
                DEFAULT_CONTACT, "公司名", "公司邮箱");
        return apiInfo;
    }
}

(3)开启swagger2的注解驱动
在这里插入图片描述
(4)测试:
http://localhost:8080/doc.html

(5)使用的注解：

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

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

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

​ @ApiImplicitParam:单个参数的说明

​ --name: 参数名

​ --value: 参数的说明

​ --require: 是否为必须的

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

@ApiModel: 实体类的说明

@ApiModelProperty: 单个参数的说明

2.整合mybatis-plus

(1)导入mybatis-plus依赖

 <!--mp的依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.2</version>
        </dependency>

（2）application.properties

#数据源信息
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# characterEncoding防止您添加到数据的数据出现乱码。
spring.datasource.url=jdbc:mysql://localhost:3306/库名?serverTimezone=Asia/Shanghai&characterEncoding=UTF8
spring.datasource.username=账号
spring.datasource.password=密码

#指定映射文件的路径--链表操作
mybatis-plus.mapper-locations=classpath:/mapper/*.xml

#sql日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

(3)表

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for student
-- ----------------------------
DROP TABLE IF EXISTS `student`;
CREATE TABLE `student`  (
  `id` int(0) NOT NULL,
  `name` varchar(20) CHARACTER SET utf8mb3 COLLATE utf8mb3_general_ci NULL DEFAULT NULL,
  `phone` varchar(11) CHARACTER SET utf8mb3 COLLATE utf8mb3_general_ci NULL DEFAULT NULL,
  `email` varchar(50) CHARACTER SET utf8mb3 COLLATE utf8mb3_general_ci NULL DEFAULT NULL,
  `profession` varchar(30) CHARACTER SET utf8mb3 COLLATE utf8mb3_general_ci NULL DEFAULT NULL,
  `age` int(0) NULL DEFAULT NULL,
  `gender` tinyint(0) NULL DEFAULT NULL,
  `status` tinyint(0) NULL DEFAULT NULL,
  `createtime` datetime(0) NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE,
  UNIQUE INDEX `phone_index`(`phone`) USING BTREE,
  INDEX `name_index`(`name`) USING BTREE,
  INDEX `pro_age_status_index`(`profession`, `age`, `status`) USING BTREE,
  INDEX `email_index`(`email`) USING BTREE,
  INDEX `gender_index`(`gender`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb3 COLLATE = utf8mb3_general_ci ROW_FORMAT = Dynamic;

-- ----------------------------
-- Records of student
-- ----------------------------
INSERT INTO `student` VALUES (1, '吕布', '17799990000', 'lvbu666@163.com', '软件工程', 23, 1, 6, '2001-02-02 00:00:00');
INSERT INTO `student` VALUES (2, '曹操', '17799990001', 'caocao666@qq.com', '通信工程', 33, 1, 0, '2001-03-05 00:00:00');
INSERT INTO `student` VALUES (3, '赵云', '17799990002', '17799990@139.com', '英语', 34, 1, 2, '2002-03-02 00:00:00');
INSERT INTO `student` VALUES (4, '孙悟空', '17799990003', '17799990@sina.com', '工程造价', 54, 1, 0, '2001-07-02 00:00:00');
INSERT INTO `student` VALUES (5, '花木兰', '17799990004', '199980729@sina.com', '软件工程', 23, 2, 1, '2001-04-22 00:00:00');
INSERT INTO `student` VALUES (6, '大乔', '17799990005', 'daqiao666@sina.com', '舞蹈', 22, 2, 0, '2001-02-07 00:00:00');
INSERT INTO `student` VALUES (7, '露娜', '17799990006', 'luna_love@sina.com', '应用数学', 24, 2, 0, '2001-02-08 00:00:00');
INSERT INTO `student` VALUES (8, '程咬金', '17799990007', 'chengyaojin@163.com', '化工', 38, 1, 5, '2001-05-23 00:00:00');
INSERT INTO `student` VALUES (9, '项羽', '17799990008', 'xiaoyu666@qq.com', '金属材料', 43, 1, 0, '2022-08-25 17:00:45');
INSERT INTO `student` VALUES (10, '白起', '17799990009', 'baiqi666@sina.com', '机械工程及其自动化', 27, 1, 2, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (11, '韩信', '17799990010', 'hanxin520@163.com', '无机非金属材料工程', 27, 1, 0, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (12, '荆轲', '17799990011', 'jinke123@163.com', '会计', 29, 1, 0, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (13, '兰陵王', '17799990012', 'lanlinwang666@126.com', '工程造价', 44, 1, 1, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (14, '狂铁', '17799990013', 'kuangtie@sina.com', '应用数学', 43, 1, 2, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (15, '貂蝉', '17799990014', '84958948374@qq.com', '软件工程', 40, 1, 3, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (16, '妲己', '17799990015', '2783238293@qq.com', '软件工程', 31, 1, 0, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (17, '芈月', '17799990016', 'xiaomin2001@sina.com', '工业经济', 35, 1, 0, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (18, '嬴政', '17799990017', '8839434342@qq.com', '化工', 38, 1, 1, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (19, '狄仁杰', '17799990018', 'jujiamlm8166@163.com', '国际贸易', 30, 1, 0, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (20, '安琪拉', '17799990019', 'jdodmlh@126.com', '城市规划', 51, 1, 0, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (21, '典韦', '17799990020', 'ycaunanjian@163.com', '城市规划', 52, 1, 2, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (22, '廉颇', '17799990021', 'lianpo321@126.com', '土木工程', 19, 1, 3, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (23, '后裔', '17799990022', 'altycj2000@139.com', '城市园林', 20, 1, 0, '2022-08-25 17:23:51');
INSERT INTO `student` VALUES (24, '姜子牙', '17799990023', '37483844@qq.com', '工程造价', 29, 1, 4, '2022-08-25 17:23:51');

SET FOREIGN_KEY_CHECKS = 1;

(4)实体类
表名和实体类名不一致: 使用@TableName(value=“表名”)
列名和实体类名不一致: 使用@TableField(value=“列名”)
主键和实体的不一致| 不叫id 使用@TableId(value=“主键列”)
如果实体类中出现某个属性 不属于表里面的字段。 @TableField(exist = false)

package com.aaa.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.format.annotation.DateTimeFormat;

import java.util.Date;

@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "学生类")
public class Student {
    @TableId(type = IdType.AUTO)
    @ApiModelProperty(value = "学生编号")
    private Integer id;
    @ApiModelProperty(value = "学上姓名")

    private String name;
    @ApiModelProperty(value = "手机号码")
    private String phone;
    @ApiModelProperty(value = "邮箱地址")
    private String email;
    @ApiModelProperty(value = "专业院系")
    private String profession;
    @ApiModelProperty(value = "学上年龄")
    private Integer age;
    @ApiModelProperty(value = "学上性别")
    private Integer gender;
    @ApiModelProperty(value = "学上身份")
    private Integer status;
    @ApiModelProperty(value = "出生日期")
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    @JsonFormat(pattern = "yyyy-MM-dd",timezone = "GMT+8")
    private Date createtime;

}

（5）dao接口

package com.aaa.dao;

import com.aaa.entity.Student;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;

public interface StudentsDao extends BaseMapper<Student> {
}

(6) 扫描dao接口
在这里插入图片描述

(7)测试

package com.aaa;

import com.aaa.dao.StudentsDao;
import com.aaa.entity.Student;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import javax.xml.crypto.Data;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;

@SpringBootTest
class Springboot03ApplicationTests {

    @Autowired
    private StudentsDao studentsDao;

    /**
     * 测试根据id查询用户信息
     */
    @Test
    void testSelectById(){
        Student student = studentsDao.selectById(1);
        System.out.println(student);
    }

    /**
     * 测试添加方法
     */
    @Test
    void testInsert(){

        Student student = new Student(null, "戈雅", "17513145220", "2024@qq.com", "软件工程",
                22, 1, 0, new Date());
        studentsDao.insert(student);
        System.out.println(student);
    }

    /**
     * 测试修改
     */
    @Test
    void testUpdate(){
        Student student = new Student(25, "赵怀真", "17513145220", "2024@qq.com", "软件工程",
                22, 1, 0, new Date());
        //studentsDao.updateById(student);
       //mp封装了一个条件类 每个条件对应一个方法:Wrapper---UpdateWrapper[增删改的条件]  QueryWrapper[查询的条件]
        UpdateWrapper<Student> wrapper = new UpdateWrapper<>();
        //where name=赵怀真
        wrapper.eq("name","赵怀真");
        //where age>18
        wrapper.ge("age",18);
        //where age<25
        wrapper.lt("age",30);
        // where age between 18 and 25
        wrapper.between("age",18,30);
        //where name like '赵%'
        wrapper.likeRight("name","赵");
        //where name like '%怀%'
        wrapper.like("name","怀");
        //where name != 赵怀真
        wrapper.ne("name","赵怀真");
        //where name not like '%怀%' or name <> '赵怀真';
        wrapper.notLike("name","怀");
        wrapper.or();
        wrapper.ne("name","赵怀真");
        studentsDao.update(student,wrapper);
    }

    /**
     * 测试删除
     */
    @Test
    void testDeleteById(){
        //根据id删除
        int deleteById = studentsDao.deleteById(25);
        //批量删除
        ArrayList<Long> ids = new ArrayList<>();
        ids.add(1l);
        ids.add(10l);
        ids.add(25l);
        studentsDao.deleteBatchIds(ids);
        //根据其他条件删除  等同于修改
        UpdateWrapper<Student> wrapper = new UpdateWrapper<>();
        wrapper.likeRight("name","赵");
        studentsDao.delete(wrapper);
    }

    /**
     * 根据条件多条记录
     */

    @Test
    public void testSelectAll(){
        QueryWrapper<Student> wrapper=new QueryWrapper<>();
        wrapper.like("name","王");
        List<Student> users = studentsDao.selectList(wrapper);
        System.out.println(users);
    }
    /**
     * 分页查询. 如果想让分页有效 必须配置分页拦截器。
     */
    @Test
    public void testSelectByPage(){
        IPage<Student> iPage=new Page(1,3);
        QueryWrapper<Student> wrapper=new QueryWrapper<>();
        wrapper.orderByDesc("id");
        //Page:分页对象  Wrapper:条件对象
        IPage<Student> page = studentsDao.selectPage(iPage, wrapper);
        System.out.println("总条数:"+page.getTotal());
        System.out.println("总页数:"+page.getPages());
        System.out.println("当前页的记录:"+page.getRecords());
    }


    @Test
    void contextLoads() {
    }

}
future_n
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
【SpringBoot】26、SpringBoot中整合MyBatis-Plus实现数据库操作
Asurplus
07-23 21万+
MyBatis 框架相信大家都用过，虽然 MyBatis 可以直接在 xml 中通过 SQL 语句操作数据库，很是灵活。但正其操作都要通过 SQL 语句进行，就必须写大量的 xml 文件，很是麻烦。于是 MyBatis-Plus 应运而生，作为 MyBatis 的增强工具，更是为我们开发效率得到了质的飞跃。 一、简介 1、MyBatis MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBa
SpringBoot 整合mybatis，mybatis-plus
热门推荐
congge_study的博客
06-23 2万+
SpringBoot 整合mybatis，mybatis-plus
【springboot实战】springBoot+mybatisplus+swagger2
杨月娥
06-17 1650
这里写自定义目录标题前言实践测试总结 前言 在公司的项目中用到了springboot，用到了swagger2这个api框架，持久层实现是jpa。小编结合项目中的框架，整合一下springboot+mybatisplus+swagger2. 实践 一、在idea里安装lombok和mybatisplus插件。 二、添加pom.xml文件依赖 <dependencies> ...
springboot+mybatis-plus+swagger2
weixin_52962125的博客
04-13 1410
springboot+mybatis-plus+swagger2
springboot整合mybatis-plus和swagger2，实现简单的增删改查和mybatis-plus的代码生成器的使用教程
weixin_43817709的博客
12-18 1296
这里写自定义目录标题前言使用的工具和技术栈新建一个springboot工程创建数据库代码生成器的配置生成各层文件Swagger2的配置类controller启动项目总结demo下载地址 前言 今天，看到mybatis-plus有代码生成器的功能，可以生成controller，server，entity等各层增删改查的代码，于是实践一下，发现真的好用！用代码生成器可以极大提高写代码的效率，简直是一个...
springboot+myBatisPlus+swagger2整合 +代码生成
for_syq的博客
03-28 1525
首先在pom.xml中导入一下包 <!--mybatis-plus--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.3.1.tmp</version>
SpringBoot集成Swagger2+MybatisPlus逆向工程生成Swagger2注解
luck_sheng的博客
03-10 1845
swagger使用指南
Springboot整合Swagger+mybatis-plus
cccy的博客
08-21 140
（简称 MP）是一个的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。插件主体 | MyBatis-Plus (baomidou.com)无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现==单表大部分 CRUD 操作==，更有强大的==条件构造器==，满足各类使用需求。
整合案例springboot整合swagger+mybatis-plus
08-16
在SpringBoot项目中整合Swagger，可以实现API接口的自动化文档生成，提高开发效率和协作能力。Swagger通过使用Swagger-UI和Swagger-Annotations，可以让开发者以注解的方式描述API，然后自动生成易于理解和使用的Web...
springboot+swagger3+mybatis-plus3.5.1代码生成+druid+log4j2【最完美】的一次配置
12-21
在本次配置中，我们将探讨如何整合SpringBoot与Swagger3、MyBatis-Plus 3.5.1、Druid和Log4j2，打造一套高效且易维护的后台系统。 Swagger3是一个强大的API文档生成工具，它可以自动生成RESTful API接口的文档，...
SpringBoot整合Mybatis-Plus+Oracle+Mysql
01-05
本教程将深入探讨如何利用SpringBoot整合Mybatis-Plus，同时支持Oracle和MySQL数据库，并通过Nacos作为注册中心，以及使用Swagger2进行API文档的生成。 首先，让我们了解SpringBoot的核心优势。SpringBoot简化了...
SpringBoot+MyBatis-Plus+Swagger简单的组合.zip
07-26
在本项目中，我们看到一个基于SpringBoot框架的整合应用，其中包括了MyBatis-Plus作为数据访问层的简化工具，以及Swagger2用于构建API文档的集成。这个组合非常适合初学者快速入门，让我们来深入了解一下这三个核心...
搭建环境IDEA下的springboot+mybatis-plus+mysql+swagger2后台+rest风格 入门
06-12
在本教程中，我们将深入探讨如何使用IntelliJ IDEA（IDEA）搭建一个基于Spring Boot、MyBatis-Plus、MySQL数据库和Swagger2的后台系统，并实现RESTful API风格的应用。这个简易示例将帮助初学者快速理解这些技术的...
idea创建spring boot项目，java版本只能选择17和21
weixin_63680330的博客
07-05 247
修改Server URL为https://start.aliyun.com。创建spring boot没有java对应11的可选。目前阿里云还是支持创建Spring2.X版本的项目的。
Spring Boot集成olingo快速入门demo
HBLOG
07-06 387
Apache Olingo 是个 Java 库，用来实现 Open Data Protocol (OData)。Apache Olingo 包括服务客户端和 OData 服务器方面。
Spring Boot与Traefik的集成
微赚淘客开发者博客
07-06 458
在当今的微服务架构中，服务的动态管理和路由是至关重要的。通过本文的介绍，我们了解了如何在Spring Boot应用中集成Traefik，实现动态的服务路由和负载均衡。在Spring Boot应用的Docker Compose或者Docker Swarm服务配置中，添加Traefik需要的标签，以便Traefik可以自动发现和路由服务。利用Traefik的动态配置能力，结合Spring Cloud配置中心（如Spring Cloud Config）或者环境变量，实现灵活的服务路由和配置管理。
科普文：spring boot中常用的接口、工具栏、注解整理
最新发布
为无为，事无事，味无味。
07-08 679
如果容器中存在ApplicationListener的Bean，当ApplicationContext调用publishEvent方法时，对应的Bean会被触发。
【Spring Boot】Spring AOP中的环绕通知
smile_sundays的博客
07-02 2565
Aspect Oriented Programming（面向切面编程）AOP是Spring框架的第⼆⼤核⼼(第⼀⼤核⼼是IoC)AOP是一种思想，是对某一类事情的集中处理。其中在下面的学习中我们会学习到拦截器、统一异常处理，统一结果处理等，这些都是运用了AOP的统一思想来实现的。
SpringBoot_113实用知识库分享
11-08
5. Swagger作为API文档生成工具，第6篇指导读者如何优雅地整合到SpringBoot项目中，便于其他开发者理解和使用API。 6. Spring AOP（面向切面编程）是实现业务逻辑分离的重要手段，第7-8篇分别介绍了AOP的详解以及...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值