springboot集成swagger2

博主：本当迷
发布时间：2022 年 09 月 24 日
894 次浏览
暂无评论
5126字数
分类： springboot

## 引入依赖：

```java
<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>

```

## swagger配置文件：

```java
package cn.bdmcom.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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @code Description
 * @code author 本当迷
 * @code date 2022/9/24-10:16
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig{
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //是否开启 (true 开启  false隐藏。生产环境建议隐藏)
                //.enable(false)
                .select()
                //扫描的路径包,设置basePackage会将包下的所有被@Api标记类的所有方法作为api
                .apis(RequestHandlerSelectors.basePackage("cn.bdmcom.controller"))
                //指定路径处理PathSelectors.any()代表所有的路径
                .paths(PathSelectors.any())
                .build();
    }

private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //设置文档标题(API名称)
                .title("后台管理系统")
                //文档描述
                .description("接口说明")
                //服务条款URL
                .termsOfServiceUrl("http://localhost:8081/")
                //版本号
                .version("1.0.0")
                .contact(new Contact("本当迷", "https://www.bdmcom.cn", "1474051104Qqq.com"))
                .build();
    }

}

```

## 实体类：

```java
package cn.bdmcom.entity;

import java.io.Serializable;
import java.util.Date;

import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.annotation.JsonIgnore;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @TableName sys_user
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("sys_user")
@ApiModel("用户实体类")
public class User implements Serializable {
    /**
     * id
     */
    @TableId(type = IdType.AUTO)
    @ApiModelProperty("用户id")
    private Integer id;

/**
     * 用户名
     */
    @TableField("username")
    @ApiModelProperty("用户名")
    private String userName;

/**
     * 密码
     */
    @JsonIgnore
    @TableField("password")
    @ApiModelProperty("用户密码")
    private String password;

/**
     * 昵称
     */
    @TableField("nickname")
    @ApiModelProperty("用户昵称")
    private String nickname;

/**
     * 邮箱
     */
    @ApiModelProperty("用户邮箱")
    private String email;

/**
     * 电话
     */
    @ApiModelProperty("用户手机号")
    private String phone;

/**
     * 地址
     */
    @ApiModelProperty("用户地址")
    private String address;

/**
     * 创建时间
     */
    @ApiModelProperty("createTime")
    private Date createTime;

/**
     * 逻辑删除 1：已删除 0：未删除
     */

@TableLogic
    @ApiModelProperty("deleted")
    private Integer deleted;

}
```

## controller接口：

```java
import com.mcy.springbootswagger.User.User;
import com.mcy.springbootswagger.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/user")
//说明接口文件
@Api(value = "测试接口", tags = "用户管理相关的接口", description = "用户测试接口")
public class UserController {
    @Autowired
    private UserService userService;

/**
     * 保存数据
     * @param user
     * @return
     */
    @PostMapping(value = "/save")
    //方法参数说明，name参数名；value参数说明，备注；dataType参数类型；required 是否必传；defaultValue 默认值
    @ApiImplicitParam(name = "user", value = "新增用户数据")
    //说明是什么方法(可以理解为方法注释)
    @ApiOperation(value = "添加用户", notes = "添加用户")
    public String saveUser(User user){
        userService.save(user);
        return "保存成功";
    }

/**
     * 根据id查询用户
     * @param id
     * @return
     */
    @GetMapping(value = "findById")
    @ApiOperation(value = "根据id获取用户信息", notes = "根据id查询用户信息")
    public User getUser(Integer id){
        return userService.findById(id);
    }

@DeleteMapping(value = "deleteById")
    @ApiOperation(value = "根据id删除数据", notes = "删除用户")
    public String delete(Integer id){
        userService.deleteById(id);
        return "删除成功";
    }
}

```

## 访问路径：

运行项目，输入http://localhost:8080/doc.html#/home访问Swagger页面

![](https://www.bdmcom.cn/usr/uploads/2022/09/4161369766.png)

最后修改：2022 年 09 月 24 日