Swagger配置MybatisPlus配置

已于 2022-05-31 19:03:08 修改
阅读量673 收藏 1
点赞数
文章标签： java spring boot restful
于 2022-05-31 18:57:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42981242/article/details/125070357
版权

项目启动访问本地地址
没有配置Swagger UI地址http://127.0.0.1:8080/swagger-ui.html
在这里插入图片描述
配置了swagger UI的地址http://localhost:8080/doc.html
在这里插入图片描述项目结构
在这里插入图片描述
引入Swagger的pom文件

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-spi</artifactId>
            <version>2.9.2</version>
        </dependency>

美化swagger UI导入，在pom文件中添加该依赖访问doc.html即可，原来的swagger依赖不删除（注意！在做了拦截的地方需要放行该地址)

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.3</version>
        </dependency>

在config包中加入配置

package com.example.demo.config;

import io.swagger.annotations.Api;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
//                .enable(swaggerEnable)
                .apiInfo(apiInfo())
                .select()
//                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) //指定扫描包
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                //只显示api路径下的页面
                //.paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("客户记录API文档")
                .description("客户记录API文档")
                .version("1.0.0")
                .build();
    }
}

pom

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

启动类上面加入@EnableSwagger2注解，扫描包@MapperScan(“com.example.demo.mapper”)

在这里插入图片描述
引入mybatis-plus

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.0</version>
        </dependency>

application.yml中连接数据库注意password密码有特殊符号需要加入’‘,例如’%Im9n9b&f’
mybatis-plus这作用是在控制台打印出执行的sql语句

# DataSource Config
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:8080/test?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: root
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

com.mysql.cj.jdbc.Driver报错，pom加入

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.22</version>
        </dependency>

数据库user.sql

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `name` varchar(30) DEFAULT NULL COMMENT '姓名',
  `age` int(11) DEFAULT NULL COMMENT '年龄',
  `email` varchar(50) DEFAULT NULL COMMENT '邮箱',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=13 DEFAULT CHARSET=utf8mb4;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', 'Jone', '18', 'test1@baomidou.com');
INSERT INTO `user` VALUES ('2', 'Jack', '20', 'test2@baomidou.com');
INSERT INTO `user` VALUES ('3', 'Tom', '28', 'test3@baomidou.com');
INSERT INTO `user` VALUES ('4', 'Sandy', '21', 'test4@baomidou.com');
INSERT INTO `user` VALUES ('5', 'Billie', '24', 'test5@baomidou.com');
INSERT INTO `user` VALUES ('6', 'Billie111', null, null);
INSERT INTO `user` VALUES ('7', 'Billi2222', null, null);
INSERT INTO `user` VALUES ('9', '456456', null, null);
INSERT INTO `user` VALUES ('10', 'Billi2222', null, null);
INSERT INTO `user` VALUES ('11', 'Billi2222', null, null);
INSERT INTO `user` VALUES ('12', '', '0', '');

entity

package com.example.demo.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

@Data
@ApiModel(value = "用户信息实体类")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    @ApiModelProperty(value = "名称")
    private String name;
    @ApiModelProperty(value = "年龄")
    private Integer age;
    @ApiModelProperty(value = "邮箱")
    private String email;
}

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo4</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo4</name>
    <description>demo4</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.0</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.22</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Mapper

package com.example.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;

public interface UserMapper extends BaseMapper<User> {
}

Service

package com.example.demo.service;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
import com.example.demo.entity.User;

public interface UserService extends IService<User> {
    IPage<User> pageInfo(IPage<User> page, String name);
}

ServiceImpl

package com.example.demo.service.impl;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import com.example.demo.service.UserService;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;

import javax.annotation.Resource;

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
    @Resource
    private UserMapper userMapper;

    @Override
    public IPage<User> pageInfo(IPage<User> page, String name) {
        LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
        wrapper.eq(!StringUtils.isEmpty(name), User::getName, name);
        return userMapper.selectPage(page, wrapper);
    }
}

mypage

package com.example.demo.vo;

import lombok.Data;

import java.io.Serializable;

@Data
public class MyPage<T> implements Serializable {

    private long total;

    private long size;

    private long current;

    private T data;

    public MyPage(long total, long size, long current, T data) {
        this.total = total;
        this.size = size;
        this.current = current;
        this.data = data;
    }
}

引入mybatisplus的分页插件MybatisPlusConfig

package com.example.demo.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.autoconfigure.ConfigurationCustomizer;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
        paginationInnerInterceptor.setDbType(DbType.MYSQL);
        paginationInnerInterceptor.setOverflow(true);
        interceptor.addInnerInterceptor(paginationInnerInterceptor);
        return interceptor;
    }

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return configuration -> configuration.setUseDeprecatedExecutor(false);
    }
}

Result

package com.example.demo.result;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.io.Serializable;

@Data
@ApiModel
public class Result<T> implements Serializable {

    @ApiModelProperty(value = "请求状态码")
    private int code;

    private String msg;
    @ApiModelProperty(value = "data")
    private T data;

    private String result;

    public Result(int code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public Result() {
    }

    public static <T> Result<T> ok(){
        return new Result<>(200,"操作成功！",null);
    }


    public static <T> Result<T> ok(T data){
        return new Result<>(200,"操作成功！",data);
    }

    public static <T> Result<T> error(String error) {
        return new Result<>(500, error, null);
    }
}

UserController 这是根据名字分页查询

package com.example.demo.controller;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.entity.User;
import com.example.demo.result.Result;
import com.example.demo.service.UserService;
import com.example.demo.vo.MyPage;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import java.util.List;

@Api(tags = "用户信息")
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @ApiOperation(value = "用户列表分页查询", notes = "用户列表分页查询")
    @GetMapping("/pageInfo")
    @ApiImplicitParams(
            {
                    @ApiImplicitParam(name = "pageNo", value = "当前页", dataType = "int", paramType = "query", example = "1", required = true),
                    @ApiImplicitParam(name = "pageSize", value = "每页显示数量", dataType = "int", paramType = "query", example = "1", required = true),
                    @ApiImplicitParam(name = "name", value = "名称", dataType = "String", paramType = "query", example = "1", required = false)
            }
    )
    public Result<MyPage<List<User>>> pageInfo(@RequestParam(value = "pageNo", defaultValue = "1") Integer pageNo,
                                               @RequestParam(value = "pageSize", required = true, defaultValue = "10") Integer pageSize,
                                               @RequestParam(value = "name", required = false) String name, HttpServletRequest request
    ) {
        IPage<User> page = new Page<>(pageNo, pageSize);
        IPage<User> userIPage = userService.pageInfo(page, name);
        return Result.ok(new MyPage<>(userIPage.getTotal(), userIPage.getSize(), userIPage.getCurrent(), userIPage.getRecords()));
    }
}

运行项目http://localhost:8080/user/pageInfo?pageNo=1&pageSize=3&name=Jone

{"code":200,"msg":"操作成功！","data":{"total":1,"size":3,"current":1,"data":[{"id":1,"name":"Jone","age":18,"email":"test1@baomidou.com"}]},"result":null}

运行Swagger
http://127.0.0.1:8080/swagger-ui.html
http://localhost:8080/doc.html

技术老鸟
关注
springBoot + MybatisPlus+Swagger 配置
kkdtcxtyi的博客
03-15 323
springBoot + MybatisPlus+Swagger 配置
代码生成工具--lombok+swagger+mybatisPlus
zheng2780071070的博客
08-31 669
1.原始项目结构 2.代码生成后结构 3.依赖包 <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupI..
Mybatis-plus整合Swagger
03-28
Mybatis-plus整合Druid+Swagger2.8，并展示分页数据。
MyBatis-Plus 和swagger
vengu733的博客
11-23 1166
Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。
mybatis-plus中Swagger 模式和Kotlin 模式是什么？
最新发布
qq_42631788的博客
08-27 576
在 MyBatis-Plus 中，Swagger 模式和 Kotlin 模式是为了支持特定技术栈和开发需求的两种配置选项。它们分别针对 API 文档生成和 Kotlin 语言提供了更好的支持和集成。
0628~项目搭建~mybatisplus~集成swagger
m0_67574688的博客
06-28 702
mybatisplus概念:mybatisplus是基于mybatis的增强工具,功能上只做加强,不做改变,每个实体类都有crud,使用mybatisplus后都可以一键生成,为提升开发效率而生,彻底解放双手;mybatis特点:1.低侵入; 2.损耗小;3.支持多种数据库;4.内置代码生成器;5.内置分页插件;1.导入依赖; 3.配置生成代码的 主类 ;4.最后新建生成的模板;（以模板为原型生成controller,mapper,query等类） controller.java.vm模板query.jav
mybatisplus+swagger2
qq_40263927的博客
05-30 455
pom.xml <!-- mybatis-plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>${mybatis-plus.version}</version> </
MyBatis-Plus系列(二)--MyBatis-Plus结合Swagger使用
热门推荐
fendo
03-28 1万+
一、简介(A)、介绍Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger的目标是对REST API定义一个标准的和语言无关的接口，可让人和计算机无需访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过Swagger进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Sw...
Springboot+dubbo+zookeeper+swagger+mybatisplus+mysql
06-30
这个项目组合"Springboot+dubbo+zookeeper+swagger+mybatisplus+mysql"正是为了实现这样的目标而设计的。让我们逐一深入探讨这些技术组件及其在系统中的作用。 首先，Spring Boot是Spring框架的一个精简版，它旨在...
springboot swagger mybatisplus，数据库连接的处理
07-15
在IT行业中，Spring Boot、Swagger和MyBatisPlus是三个非常重要的工具，它们分别用于构建高效、简洁的Java Web应用，API文档的生成，以及简化数据库操作。让我们深入探讨这三个技术以及它们如何协同处理数据库连接。...
SpringBoot+Mybatisplus+Mybatis+Swagger+代码自动生成
qq_41928043的博客
07-19 768
Springboot+mybaisplus+swagger
mybatis-plus生成的实体类支持swagger2
07-23
mybatis-plus生成的实体类支持swagger2,controlle不支持 mybatis-plus的版本是2.1.8 swagger2的版本是2.9.2
mybatis代码自动生成工具含swagger2 配置
03-28
mybatis自动生成工具，带swagger2注释 以及时间格式处理
springboot+mybatis+mybatisplus+swagger框架整合
08-31
springboot+mybatis+mybatisplus+swagger框架整合
springboot+mybatis-plus+swagger2全注释入门demo，让你代码更优雅
04-04
里面有我修改后的代码生成器，写了齐全的注释最好的入门demo，能直接生成swagger2注解的代码，主要属性已经提取成配置文件可以直接多表生成，restful风格让你的代码更优雅
Springboot-mybatisplus-Swagger
Ais永恒
11-30 360
这个是之前搭建的一个demo，mybatisplus的版本是2.3.1，如果是用新版本可以看我另一篇文章，是mybatisplus分页的那个。 Springboot+mybatis-plus+Swagger初始环境搭建+demo演示 环境的继承，mybatis-plus的代码生成，以及swagger接口文档的展示。 SpringBoot配置热部署 &lt;!-- 修改后立即生效，热部署...
springboot项目初始化--mybatisplus代码生成和swagger配置
weixin_42821448的博客
07-28 630
springboot项目初始化之mybatisplus代码生成和 swagger配置
Mybatis plus&Swagger&代码生成器
rapid2011的专栏
03-02 1009
原因：Mapper文件中都要加上 @Param("pageNum")
实战六：SpringBoot集成mybatis-plus和swagger
shieryue_2016的博客
12-08 1005
需要在application.properties添加。
springboot mybatisplus swagger
10-13
它提供了自动配置、快速启动、无代码生成等特性，使得开发者可以更加专注于业务逻辑的实现。 MyBatis Plus是MyBatis的增强工具，它提供了很多实用的功能，如自动生成代码、分页插件、性能分析插件等。使用MyBatis ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值