swagger2的使用java集成

本文主要是介绍swagger2的使用java集成，对大家解决编程问题具有一定的参考价值，需要的程序猿们随着小编来一起学习吧！

1.pom文件添加对应的依赖

io.springfox
springfox-swagger2
2.9.2


io.springfox
springfox-swagger-ui
2.9.2

2.启动类开启swagger2

@SpringBootApplication
@EnableSwagger2
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

3.使用对应的注解

@Api("用户")
@RestController
@RequestMapping("/test")
public class TestController {
    @ApiOperation("修改密码")
    @GetMapping("/changePassword")
    public String changePassword(){
        //判断必填参数是否为空
        return null;
    }
}
@ApiModel("用户表")
public class Class {
    @ApiModelProperty("id")
    private Long id;
    
    @ApiModelProperty("姓名")
    private String name;
}

swagger2常用注解

@Api()用于类；
表示标识这个类是swagger的资源
@ApiOperation()用于方法；
表示该请求的说明
@ApiParam()用于方法，参数，字段说明；
表示对参数的添加元数据（说明或是否必填等）

@ApiModel()用于类
表示对类进行说明，用于参数用实体类接收
@ApiModelProperty()用于方法，字段
表示对model属性的说明或者数据操作更改

@ApiImplicitParam() 用于方法
表示单独的请求参数
@ApiImplicitParams() 用于方法
包含多个 @ApiImplicitParam

这篇关于swagger2的使用java集成的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！