springBoot 使用Swagger2，做测试和api文档

1、pom

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.2.2</version>
        </dependency>

        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
        </dependency>

2、Swagger2Manager（主页信息设置）

/**
 * Created on 2019/9/9.
 *
 *  生成api说明文档。并且可以使用里面的方法设置参数，测试。
 *  访问地址  localhost:8080/swagger-ui.html
 * @author Grak
 * @since 1.0
 */
@Configuration
@EnableSwagger2
public class Swagger2Manager {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) //配置api路径
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("结合swagger使用，实现api说明文档")
                .description("个人学习使用，以后可用作测试！！")
                .termsOfServiceUrl("www.baidu.com") //个人主页，公司主页
                .contact("走在程序猿的路上！")
                .version("1.0")
                .build();
    }
}

3、测试实体类

@Data
public class User {

    private String name;

    private int age;

    private String address;

    private String description;
}

4、测试用controller接口

/**
 * Created on 2019/9/9.
 *
 * @author Grak
 * @since 1.0
 */
@RestController("/user")
public class UserController {

    private Map<String,User> userList = new HashMap<>();

    @ApiOperation(value = "获取用户信息",notes = "通过用户名字作为key，获取详细信息")
    @ApiImplicitParam(name = "name",value = "用户姓名",required = true, dataType = "String")
    @RequestMapping(value = "/find",method = RequestMethod.GET)
    public User getUser(@ModelAttribute String name){
        return userList.get(name);
    }

    @ApiOperation(value = "添加用户信息",notes = "直接使用用户实体类创建，里面名字是必须填写的。")
    @ApiImplicitParam(name = "user",value = "用户实体类",required = true, dataType = "User")
    @RequestMapping(value = "/add",method = RequestMethod.POST)
    public String addUser(@ModelAttribute User user){
        if(user != null){
            userList.put(user.getName(),user);
            return "success";
        }else {
            return "玩家数据异常！！";
        }
    }

    @ApiOperation(value = "删除用户信息",notes = "通过用户名字作为key，年龄只是说明可使用多个参数。没具体作用！")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "age",value = "用户年龄",required = false, dataType = "Integer"),
            @ApiImplicitParam(name = "name",value = "用户姓名",required = true, dataType = "String")
    })
    @RequestMapping(value = "/delete",method = RequestMethod.GET)
    public int deleteUser(@PathVariable String name,@PathVariable int age){
        userList.remove(name);
        return userList.size();
    }

    @ApiOperation(value = "修改用户信息",notes = "直接使用名字修改，名字不能改！")
    @ApiImplicitParam(name = "user",value = "用户实体类",required = true, dataType = "User")
    @RequestMapping(value = "/modify",method = RequestMethod.POST)
    public String updateUser(@ModelAttribute User user){
        User userSelf = userList.get(user.getName());
        if(userSelf != null){
            if(user.getName() != null){
                userSelf.setName(user.getName());
            }
            if(user.getAge() > 0){
                userSelf.setAge(user.getAge());
            }
            if(user.getAddress() != null){
                userSelf.setAddress(user.getAddress());
            }
            if(user.getDescription() != null){
                userSelf.setDescription(user.getDescription());
            }
            return "success";
        }else {
            return "修改参数异常！！";
        }
    }
}

5、效果 （localhost:8080/swagger-ui.html）