12-springboot集成Swagger-526互联

Swagger2 的作用：

随项目自动生成强大RESTful API文档，减少工作量；（不需要自己写api文档了）

API文档与代码整合在一起，便于同步更新API文档的说明；

页面测试功能来调试每个RESTful API；

怎么集成？

1、添加相关依赖

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

</dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

</dependency>

2、配置文件（暂时不需要在application.properties配置）

3、编写相关代码，可能需要用到一些注解；

@Api("springboot使用swagger测试")
@RestController
public class SwaggerController {

    @ApiOperation(value = "获取用户信息", notes = "根据id来获取用户详细信息")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "path", name = "id", value = "用户ID", dataType = "Integer"),
            @ApiImplicitParam(paramType = "path", name = "status", value = "用户状态", dataType = "Integer")
    })
    @ApiResponses({
            @ApiResponse(code = 400, message = "缺少必要的请求参数"),
            @ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对")
    })
    @RequestMapping(value = "/swagger/{id}/{status}",method = RequestMethod.GET)
    public Users getInfo(@PathVariable("id") Integer id, @PathVariable("status") Integer status) {
        Users users = new Users();
        users.setNick("Tom");
        users.setPhone("13922222342");
        users.setPassword("******");
        users.setEmail("cat@163.com");
        users.setAccount("no12");
        return users;
    }
}