springboot整合swagger

springboot整合swagger

前后端分离后，维护接口文档基本上是必不可少的工作。一个理想的状态是设计好后，接口文档发给前端和后端，大伙按照既定的规则各自开发，开发好了对接上了就可以上线了。当然这是一种非常理想的状态，实际开发中却很少遇到这样的情况，接口总是在不断的变化之中，有变化就要去维护，做过的小伙伴都知道这件事有多么头大！还好，有一些工具可以减轻我们的工作量，Swagger2就是其中之一

1.第一步在springboot项目中导入依赖

<!--swagger文档功能-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>	

pom文件要 有的ar 如图

2.还需要一个 类

如图

@Component
@EnableSwagger2
public class SwaggerConfig {
}

3.创建一个contraller

如图：

@RestController
@Api(value = "测试控制器",tags = "测试控制器")
public class TestController {

    @RequestMapping("returnList")
    @ApiOperation("方法返回一个list集合")
    public List<String> returnList(){
        List<String> list=new ArrayList<String>();
        list.add("a");
        list.add("b");
        list.add("c");
        list.add("d");
    return list;
    }

}

4.开启项目 访问 以下网址

http://localhost:8080/swagger-ui.html

成功
参数解释:

1.@Api注解可以用来标记当前Controller的功能。

2.@ApiOperation注解用来标记一个方法的作用。

3.@ApiImplicitParam注解用来描述一个参数，可以配置参数的中文含义，也可以给参数设置默认值，这样在接口测试的时候可以避免手动输入。

4.如果有多个参数，则需要使用多个@ApiImplicitParam注解来描述，多个@ApiImplicitParam注解需要放在一个@ApiImplicitParams注解中。

5. 需要注意的是，@ApiImplicitParam注解中虽然可以指定参数是必填的，但是却不能代@RequestParam(required = true)，前者的必填只是在Swagger2框架内必填，抛弃Swagger2，这个限制就没用了，所以假如开发者需要指定一个参数必填，@RequestParam(required = true)注解还是不能省略。
6. 如果参数是一个对象（例如上文的更新接口），对于参数的描述也可以放在实体类中。例如下面一段代码：

@ApiModel
public class User {
    @ApiModelProperty(value = "用户id")
    private Integer id;
    @ApiModelProperty(value = "用户名")
    private String username;
    @ApiModelProperty(value = "用户地址")
    private String address;
    //getter/setter
}