springboot集成使用swagger2

最新推荐文章于 2024-01-06 22:13:59 发布

疯子也是猖狂

最新推荐文章于 2024-01-06 22:13:59 发布

阅读量2k

点赞数 1

分类专栏： java 文章标签： Swagger2

本文链接：https://blog.csdn.net/qq_41755287/article/details/102917439

版权

java 专栏收录该内容

18 篇文章 0 订阅

订阅专栏

创建springboot就不说了很简单

在pom中添加swagger2依赖

<!--swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

接下来写Swagger2的配置文件

此处我创建了两个模块在Select a spec选择的。

此处一定要修改扫描包路径

package com.allmodel.models.config;

/**
 * @Author WQY
 * @Date 2019/10/19 10:29
 * @Version 1.0
 */
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2的配置类
 * Created by 30721 on 2019/7/7.
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean("Authority")
    public Docket apiAuthority() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("权限模块接口")
                .apiInfo(apiInfo())
                .select()
                // 自行修改为自己的包路径
                .apis(RequestHandlerSelectors.basePackage("com.allmodel.models.authority.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    @Bean("Test")
    public Docket apiTest() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("测试模块接口")
                .apiInfo(apiInfo())
                .select()
                // 自行修改为自己的包路径
                .apis(RequestHandlerSelectors.basePackage("com.allmodel.models.test.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("模块接口")
                .description("")//swagger UI接入教程
                //服务条款网
                .termsOfServiceUrl("")
                //版本号
                .version("1.0")
                .build();
    }
}

然后在controller和实体类种添加注解，形成接口说明

比如用户管理的这个接口

@Controller
@RequestMapping("/user")
@Api(value = "用户组织机构管理")
public class UserManagement {

    @Autowired
    private UserManagementService userManagementService;

    /**
     * 添加用户
     * @param userEntity
     * @return
     */
    @RequestMapping(value = "/adduser",method = RequestMethod.POST)
    @ResponseBody
    @ApiOperation(value = "添加用户")
    public OutView<String> addUser(@ApiParam(name = "userEntity",value = "传入json格式",required = true) UserEntity userEntity){

        String rs = userManagementService.addUser(userEntity);

        OutView outView = new OutView();

        try {
            outView.setState(0);
            outView.setMsg(rs);
            return outView;
        }catch (Exception e){
            outView.setState(1);
            outView.setMsg(rs);
            return outView;
        }
    }

    /**
     * 获取用户列表
     * @param orgnum
     * @return
     */
    @RequestMapping(value = "/getorglist",method = RequestMethod.POST)
    @ResponseBody
    @ApiOperation(value = "获取用户列表")
    @ApiImplicitParam(value = "组织机构编码",name = "orgnum",dataType = "String",required = true)
    public OutView<List<UserEntity>> getOrgList(String orgnum){
        OutView outView = new OutView();
        try {
            List<UserEntity> rs = userManagementService.getuserlist(orgnum+"%");
            outView.setState(0);
            outView.setMsg(rs);
            return outView;
        }catch (Exception e){
            outView.setState(1);
            outView.setMsg("获取失败");
            return outView;
        }
    }
}

用法介绍

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性

在刚才上面代码中有个返回类型为

OutView<List<UserEntity>>

的接口。

此处如果想要对方看见字段的解释一定要在实体类中加上泛型，不然是看不见你在UserEntity中做的注解

由于我项目中用的是JPA,所以请忽略JPA注解即可

就是忽略非@Api开口的注解

package com.allmodel.models.authority.entity;

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

import javax.persistence.*;
import java.util.Date;

/**
 * @Description  
 * @Author  WQY
 * @Date 2019-11-05 
 */

@Entity
@Table ( name ="user" )
@ApiModel(value = "user",description = "用户对象user")
public class UserEntity  {

	@Id
	@GeneratedValue(strategy = GenerationType.IDENTITY)
   	@Column(name = "id" )
	@ApiModelProperty(hidden = true)
	private Long id;

	/**
	 * 用户名
	 */
   	@Column(name = "username" )
	@ApiModelProperty(value = "用户名",name = "username",required = true,dataType = "String")
	private String username;

	/**
	 * 密码
	 */
   	@Column(name = "password" )
	@ApiModelProperty(value = "密码",name = "password",required = true,dataType = "String")
	private String password;

	/**
	 * 保存时间
	 */
   	@Column(name = "savetime" )
	@ApiModelProperty(hidden = true)
	private Date savetime;

	/**
	 * 手机号
	 */
   	@Column(name = "iphone" )
	@ApiModelProperty(value = "手机号",name = "iphone")
	private String iphone;

	/**
	 * 权限,1是最大权限，2是最小权限
	 */
   	@Column(name = "authority" )
	@ApiModelProperty(value = "权限",name = "authority")
	private Long authority;

	/**
	 * 性别，1男，2女
	 */
   	@Column(name = "sex" )
	@ApiModelProperty(value = "性别",name = "sex")
	private String sex;

	/**
	 * 组织机构编号
	 */
   	@Column(name = "organization_num" )
	@ApiModelProperty(value = "组织机构标号",name = "organizationNum",required = true,dataType = "String")
	private String organizationNum;

	/**
	 * 组织机构名称
	 */
   	@Column(name = "organization_name" )
	@ApiModelProperty(value = "组织机构名称",name = "organizationName",required = true,dataType = "String")
	private String organizationName;


}

然后访问http://localhost:端口/swagger-ui.html

就可以看到页面了

箭头指的就是刚才添加的两个接口

因为这两个接口是在权限模块接口下，所以Select a spec选的是权限模块接口