下面两篇文章完成了springboot，mybatis-plus，mysql集成开发。
springboot+mybatis-plus+mysql入门实例
MyBatis-plus自动代码生成的实体不包含@TableId,@TableName
本文将在此基础的代码上来集成swagger。
话不多说，现在就开始吧！
在pom.xml中引入swagger的依赖包。springfox-swagger-ui这个是swagger默认的前端界面。swagger-bootstrap-ui这个界面好用一些，不是必须引入的。
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>在controller这一层的代码当中加入swagger注解。
package com.xiaotong.demo.controller;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.xiaotong.demo.entitiy.User;
import com.xiaotong.demo.service.UserService;
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.*;
import java.util.List;
/**
*
* @author xiaotong
* @since 2021-06-08
*/
@RestController
@RequestMapping("/user")
@Api(tags = "用户相关接口")
public class UserController {
@Autowired
private UserService userService;
/**
* 新增更新用户
*/
@ApiOperation(value = "新增更新用户", notes = "新增更新用户")
@RequestMapping(value = "/addorupdate", method = RequestMethod.POST)
@ResponseBody
public User addOrUpdateUser(@RequestBody User user) {
return userService.addOrUpdateUser(user);
}
/**
* 单个用户查询
*/
@ApiOperation(value = "单个用户查询", notes = "单个用户查询")
@ApiImplicitParams({
@ApiImplicitParam(name = "userid", value = "用户id", dataType = "String"),
})
@RequestMapping(value = "/get", method = RequestMethod.GET)
@ResponseBody
public User getUser(String userid){
return userService.getUser(userid);
}
/**
* 删除单个用户
*/
@ApiOperation(value = "删除单个用户", notes = "删除单个用户")
@ApiImplicitParams({
@ApiImplicitParam(name = "userid", value = "用户id", dataType = "String"),
})
@RequestMapping(value = "/del", method = RequestMethod.POST)
@ResponseBody
public boolean delUser(String userid){
return userService.delUser(userid);
}
/**
* 用户列表查询
*/
@ApiOperation(value = "用户列表查询", notes = "用户列表查询")
@ApiImplicitParams({
@ApiImplicitParam(name = "name", value = "用户名", dataType = "String"),
})
@RequestMapping(value = "/list", method = RequestMethod.GET)
@ResponseBody
public List<User> findUserList(String name){
return userService.findUserList(name);
}
/**
* 用户列表分页查询
*/
@ApiOperation(value = "用户列表分页查询", notes = "用户列表分页查询")
@ApiImplicitParams({
@ApiImplicitParam(name = "name", value = "用户名", dataType = "String"),
@ApiImplicitParam(name = "pageNum", value = "页码", dataType = "Integer"),
@ApiImplicitParam(name = "pageSize", value = "每页条数", dataType = "Integer")
})
@RequestMapping(value = "/page/list", method = RequestMethod.GET)
@ResponseBody
public Page<User> findUserPageList(Integer pageNum, Integer pageSize,String name){
if(null == pageNum){
pageNum = 1;
}
if(null == pageSize){
pageSize = 10;
}
return userService.findUserPageList(pageNum,pageSize,name);
}
}实体模型中加入swagger注解。
package com.xiaotong.demo.entitiy;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
/**
* <p>
* 用户表
* </p>
*
* @author xiaotong
* @since 2021-06-10
*/
@ApiModel("用户模型")
@TableName("user")
public class User implements Serializable {
private static final long serialVersionUID = 1L;
/**
* userid
*/
@ApiModelProperty("用户id")
@TableId(value = "userid", type = IdType.INPUT)
private String userid;
/**
* 姓名
*/
@ApiModelProperty("姓名")
@TableField("name")
private String name;
/**
* 年龄
*/
@ApiModelProperty("年龄")
@TableField("age")
private Integer age;
public String getUserid() {
return userid;
}
public void setUserid(String userid) {
this.userid = userid;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return "User{" +
"userid=" + userid +
", name=" + name +
", age=" + age +
"}";
}
}在启动类上加上@EnableSwagger2注解启用swagger。
package com.xiaotong.demo;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@SpringBootApplication
@EnableSwagger2
@MapperScan("com.xiaotong.demo.mapper")
public class XiaotongdemoApplication {
public static void main(String[] args) {
SpringApplication.run(XiaotongdemoApplication.class, args);
}
}加入swagger配置类，可以配置一些界面显示的信息，不是必须的，不加入也是可以正常使用。
package com.xiaotong.demo.config;
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 docket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.xiaotong.demo.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("成小同api管理")
.build();
}
}启动程序，浏览器访问http://127.0.0.1:8089/doc.html看看效果吧！下面是swagger-bootstrap-ui的交互界面。
浏览器访问http://127.0.0.1:8089/swagger-ui.html可以查看swagger默认的交互界面。
好了，这篇文章到此就结束了。
有问题欢迎反馈，大家一起交流学习！
相关文章
本文暂时没有评论，来添加一个吧(●'◡'●)