springboot整合swagger2接口文档和mybatis-plus

最新推荐文章于 2023-05-17 19:57:39 发布
最新推荐文章于 2023-05-17 19:57:39 发布
阅读量712 收藏
点赞数 1
文章标签： spring boot java spring cloud
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44786856/article/details/122210787
版权

SpringBoot Swagger2 Mybatis-Plus API文档 接口测试
关键词由CSDN通过智能技术生成

springboot整合swagger2接口文档和mybatis-plus

使用mybatis-plus对员工表的增删改查
项目结构
在这里插入图片描述
jar包

  <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.13</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.9.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.2.1</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.2</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

注意：
springboot的版本号最新版本swagger会出现问题

 <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

mabatis最新版本加上

@Configuration
public class MybatisPlusConfig {


    // 最新版
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }

}

swagger

@Configuration
public class Swagger {
    //获取Swagger2的实例对象Docket。
    @Bean
    public Docket getDocket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("143").apiInfo(apiInfo())
                .select()
                //为指定的包生成api文档
                .apis(RequestHandlerSelectors.basePackage("com.ccr.controller"))
                //为指定的路径生成api文档
                //.paths(PathSelectors.any())
                .build();
        return docket;
    }

    private ApiInfo apiInfo(){
        Contact DEFAULT_CONTACT = new Contact("程哈哈", "http://www.test.com", "2665488005@qq.com");
        ApiInfo apiInfo = new ApiInfo("员工管理", "员工管理", "2.0",
                "http://www.test.com",
                DEFAULT_CONTACT, "test", "http://www.test.com", new ArrayList<VendorExtension>());
        return apiInfo;
    }
}

启动类


@SpringBootApplication
@MapperScan(basePackages = "com.ccr.dao")
@EnableSwagger2 //开启swagger
public class SpringbootMybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisPlusApplication.class, args);
    }

}

CommonResult


@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "状态码")
public class CommonResult {
    @ApiModelProperty(value = "返回的状态码200成功")
    private Integer code;
    @ApiModelProperty(value = "提示信息")
    private String msg;
    @ApiModelProperty(value = "返回的数据")
    private Object data;
}

EmpService

public interface EmpService {
    //    根据id查询信息
    public CommonResult selectById(Long empId );
    //    查询所有分页
    public CommonResult selectByPage(Integer page,Integer limit);
    //    添加信息
    public CommonResult addEmp(Emp emp);
    //    修改
    public CommonResult upEmp(Emp emp);
    //    删除
    public CommonResult delEmp(Long empId);
}

EmpServiceImpl

@Service(value = "empService")
public class EmpServiceImpl implements EmpService {
    @Resource
    public EmpDao empDao;
    @Override
    public CommonResult selectById(Long empId) {
        Emp emp = empDao.selectById(empId);
        return new CommonResult(200,"查询成功",emp);
    }

    @Override
    public CommonResult selectByPage(Integer page, Integer limit) {
        final Page<Emp> empPage = new Page<>(page,limit);
        final Page<Emp> empPage1 = empDao.selectPage(empPage, null);
        return  new CommonResult(200,"查询成功",empPage1);
    }
//  添加
    @Override
    public CommonResult addEmp(Emp emp) {
        int insert = empDao.insert(emp);
        return  new CommonResult(200,"添加成功",insert);
    }

    @Override
    public CommonResult upEmp(Emp emp) {

        final int i = empDao.updateById(emp);
        return  new CommonResult(200,"更新",i);
    }

    @Override
    public CommonResult delEmp(Long empId) {
        final int i = empDao.deleteById(empId);
        return new CommonResult(200,"删除成功",i);

    }
}

Emp

@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName(value = "tbl_emp") //表名和实体类不同时
@ApiModel(value = "员工表")//实体类说明
public class Emp {
    //    实体类中的属性
    @ApiModelProperty(value = "员工id编号")
    @TableId(value = "empId", type = IdType.ASSIGN_ID)
    private Long empId;

    @ApiModelProperty(value = "员工姓名")
    @TableField(value = "empName")
    private String empName;

    @ApiModelProperty(value = "员工性别")
    private char gender;

    @ApiModelProperty("员工邮箱")
    private String email;

    @ApiModelProperty("员工所在的部门编号")
    @TableField(value = "d_Id")
    private Integer dId;
}

EmpDao


public interface EmpDao extends BaseMapper<Emp> {
}

EmpController


@RestController
@RequestMapping("emp")
@Api(tags = "员工表的增删改")
public class EmpController {
    @Autowired
    private EmpService empService;
//    根据id查询
    @GetMapping("/getById")
    @ApiOperation(value = "根据id查询员工信息")
    @ApiImplicitParams(
            @ApiImplicitParam (name = "empId",value = "员工id号",dataType = "Integer" ,required = true)
    )
    public CommonResult getById(Long empId){
        return empService.selectById(empId);
    }

    //    查询所有信息分页
    @GetMapping("/getAll")
    @ApiOperation(value = "查询所有分页")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "page", value = "页数", dataType = "Integer", required = true),
            @ApiImplicitParam(name = "limit", value = "一页条数", dataType = "Integer", required = true)
    })
    public CommonResult getAll(Integer page,Integer limit){
        return empService.selectByPage(page,limit);
    }
    //    添加
    @PostMapping("/addEmp")
    @ApiOperation(value = "添加员工")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empId", value = "员工id",required = false,paramType = "添加",dataType="Long"),
            @ApiImplicitParam(name = "empName", value = "员工姓名",required = true,paramType = "添加",dataType="String"),
            @ApiImplicitParam(name = "gender", value = "员工性别",required = true,paramType = "添加",dataType = "char"),
            @ApiImplicitParam(name = "email", value = "邮箱",required = true,paramType = "添加",dataType = "String"),
            @ApiImplicitParam(name = "dId", value = "部门",required = true,paramType = "添加",dataType = "Integer"),
    })
    public CommonResult addEmp(Long empId,String empName,char gender,String email,Integer dId){
        Emp emp = new Emp(empId,empName,gender,email,dId);
//        System.out.println(emp);
        return empService.addEmp(emp);
    }
    //    修改
    @PutMapping("upEmp")
    @ApiOperation(value = "修改员工")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empId", value = "员工id",required = true,paramType = "修改",dataType="Long"),
            @ApiImplicitParam(name = "empName", value = "员工姓名",required = true,paramType = "修改",dataType="String"),
            @ApiImplicitParam(name = "gender", value = "员工性别",required = true,paramType = "修改",dataType = "char"),
            @ApiImplicitParam(name = "email", value = "邮箱",required = true,paramType = "修改",dataType = "String"),
            @ApiImplicitParam(name = "dId", value = "部门",required = true,paramType = "修改",dataType = "Integer"),
    })
    public CommonResult upEmp(Long empId,String empName,char gender,String email,Integer dId){
        Emp emp = new Emp(empId, empName, gender, email, dId);
        return empService.upEmp(emp);
    }
    //    删除
    @DeleteMapping("delEmp")
    @ApiOperation(value = "删除员工")
    @ApiImplicitParams(
            @ApiImplicitParam(name = "empId", value = "员工id",required = true,paramType = "删除",dataType = "Long"))
    public CommonResult delEmp(Long empId){
        return empService.delEmp(empId);
    }

}

applicatication.yml

#配置端口号
server:
  port: 8080
# 配置druid的信息
spring:
  datasource:
    druid:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/emp?serverTimezone=Asia/Shanghai
      username: root
      password: root
      max-active: 20
      initial-size: 5
      min-idle: 5
      max-wait: 3000

logging:
  level:
    com.ccr.dao: debug
pagehelper:
  reasonable: true

运行结果

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

SSID-cc-r
关注
【SpringBoot】16、SpringBoot中整合Swagger2接口文档
Asurplus
04-21 20万+
接口文档在我们日常开发工作中起到不可或缺的作用，特别是前后端分离的项目，需要使用接口文档来进行通信，而 Swagger2 是开源免费使用的，是一个减轻我们工作量的一款不错的工具 1、引入 Swagger2 依赖 <!-- swagger2 --> <dependency> <groupId>io.springfox</groupId> ...
【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集成Swagger2生成接口文档
weixin_34102807的博客
12-19 107
原文地址： itweknow.cn/detail?id=5… ，欢迎大家访问。 我们提供Restful接口的时候，API文档是尤为的重要，它承载着对接口的定义，描述等。它还是和API消费方沟通的重要工具。在实际情况中由于接口和文档存放的位置不同，我们很难及时的去维护文档。个人在实际的工作中就遇到过很多接口更新了很久，但是文档却还是老版本的情况，其实在这个时候这份文档就已经失去了它存在的意义。而...
SpringBoot 集成 swagger2 接口文档
qq_33304139的博客
11-21 130
概要 简单分享关于SpringBoot（maven）集成swagger api接口文档的方法，此处使用的界面ui为BootstrapUi，其界面如下 主要过程 1.添加依赖 在pom文件中添加以下依赖 <!-- 由于是springfox-swagger的增强UI包,所以基础功能依然依赖Swagger,springfox-swagger的jar包必须引入 --> <dependency> <groupId>io.springfox</
springboot整合swagger2接口文档
老王不掉头发的博客
02-22 404
swagger2配置方法
SpringBoot中整合Swagger2接口文档
最新发布
qq_58000391的博客
05-17 895
dataType：参数类型，默认String，其它值dataType="Integer"· header --> 请求参数的获取：@RequestHeader。· path（用于restful接口）--> 请求参数的获取：@PathVariable。· query --> 请求参数的获取：@RequestParam。@ApiImplicitParam：对单个参数的说明。@ApiImplicitParams：用在请求的方法上，包含一组参数说明。@ApiOperation："用在请求的方法上，说明方法的作用"
整合案例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，mybatis-plus
congge_study的博客
06-23 2万+
SpringBoot 整合mybatis，mybatis-plus
详解SpringBoot结合swagger2快速生成简单的接口文档
08-26
主要介绍了详解SpringBoot结合swagger2快速生成简单的接口文档，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
SpringBoot整合Swagger2接口文档
m0_46881781的博客
03-25 119
SpringBoot整合Swagger2 1、创建springboot项目，引入swagger2的依赖，完整依赖如下： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <depe
【SpringBoot】整合Swagger2 接口文档
m0_62220641的博客
05-06 1421
前言 可能运用的开发模式： SSM -> SpringMVC + Spring + Mybatis SSMP -> SpringMVC + Spring + MybatisPlus SM -> SpringBoot + Mybatis SMP -> SpringBoot + MybatisPlus 分布式 微服务 前后端分离 网站架构基本都由原来的后端渲染，变成了：前端渲染、前后端分离的形态， 而且前端技术和后端技术在各自的道路上越走越远。 ..
SpringBoot整合Swagger2，形成接口文档
追风筝的人博客
12-20 483
当然，首先是创建一个Spring Boot项目，加入web依赖，创建成功后，加入两个Swagger2相关的依赖，完整的依赖如下： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> &lt...
SpringBoot进行整合Swagger2从此接口文档说拜拜
一起记录GIS学习
04-15 181
SpringBoot进行Swagger的整合非常方便我们进行接口对接和调试。接口文档也不用给前端提供了，简直酸爽。。。。。 我们首先需要引入Swagger的Jar包 一、依赖 <!--整合swagger--> <!-- swagger --> <dependency> <groupId&gt...
SpringBoot整合Swagger2生成接口文档
男人要霸气的博客
09-03 366
一、导入依赖 <!-- 导入swagger2的包--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependenc
SpringBoot整合Swagger2实现API文档
“SpringBoot整合Swagger2的详细文档，包含了整合步骤和相关参数说明。” 在SpringBoot项目中集成Swagger2能够方便地创建API的在线文档，提高开发效率并便于团队协作。Swagger2是一个强大的RESTful API文档工具，它...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值