SpringBoot2.x系列教程13--SpringBoot中整合Swagger生成接口的在线文档

packagecom.yyg.boot.config;
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.ComponentScan;
importorg.springframework.context.annotation.Configuration;
importspringfox.documentation.builders.ApiInfoBuilder;
importspringfox.documentation.builders.RequestHandlerSelectors;
importspringfox.documentation.service.ApiInfo;
importspringfox.documentation.service.Contact;
importspringfox.documentation.spi.DocumentationType;
importspringfox.documentation.spring.web.plugins.Docket;
importspringfox.documentation.swagger2.annotations.EnableSwagger2;
/*** @Author 一一哥Sun* @Date Created in 2020/5/13* @Description Description*/@Configuration@EnableSwagger2//@ComponentScan(basePackages = "com.yyg.boot.web")publicclassSwagger2Config {
@BeanpublicDocketapi() {
returnnewDocket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .apis(RequestHandlerSelectors.basePackage("com.yyg.boot.web"))
//.paths(PathSelectors.any())                .build()
                .apiInfo(apiInfo());
    }
privateApiInfoapiInfo() {
returnnewApiInfoBuilder()
                .title("XXX项目接口文档")
                .description("XXX项目接口测试")
                .version("1.0.1")
                .contact(newContact("一一哥","https://yiyige.blog.csdn.net/","2312119590"))
                .termsOfServiceUrl("")
                .license("")
                .licenseUrl("")
                .build();
    }
}

packagecom.yyg.boot.domain;
importio.swagger.annotations.ApiModel;
importio.swagger.annotations.ApiModelProperty;
importlombok.Data;
importjava.io.Serializable;
/*** @Author 一一哥Sun* @Date Created in 2020/5/13* @Description Description*/@Data@ApiModelpublicclassUserimplementsSerializable {
@ApiModelProperty("用户id")
privateLongid;
@ApiModelProperty("用户姓名")
privateStringname;
@ApiModelProperty("用户年龄")
privateIntegerage;
}

packagecom.syc.boot.web;
importcom.syc.boot.domain.User;
importio.swagger.annotations.ApiImplicitParam;
importio.swagger.annotations.ApiImplicitParams;
importio.swagger.annotations.ApiOperation;
importorg.springframework.web.bind.annotation.*;
importjava.util.*;
@RestController// 通过这里配置使下面的映射都在/users下@RequestMapping(value="/users")
publicclassUserController {
// 创建线程安全的MapstaticMap<Long, User>users=Collections.synchronizedMap(newHashMap<>());
// 处理GET请求,用来获取用户列表.// 可以通过@RequestParam获取从页面中传递进来的查询条件或者翻页信息等参数.@ApiOperation(value="获取用户列表", notes="")
@RequestMapping(value="/", method=RequestMethod.GET)
publicList<User>getUserList() {
returnnewArrayList<>(users.values());
    }
// 处理POST请求,用来创建User.// 除了@ModelAttribute绑定参数之外,还可以通过@RequestParam从页面中传递参数.@ApiOperation(value="创建用户", notes="根据User对象创建用户")
@ApiImplicitParam(name="user", value="用户详细实体user", required=true, dataType="User")
@RequestMapping(value="/", method=RequestMethod.POST)
publicStringaddUser(@RequestBodyUseruser) {
users.put(user.getId(), user);
System.out.println("user==="+users.get(user.getId()));
return"success";
    }
// 处理GET请求,用来获取url中id值的User信息;// url中的id可通过@PathVariable绑定到函数的参数中.@ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
@ApiImplicitParam(name="id", value="用户ID", required=true, dataType="Long")
@RequestMapping(value="/{id}", method=RequestMethod.GET)
publicUsergetUser(@PathVariableLongid) {
returnusers.get(id);
    }
// 处理PUT请求,用来更新User信息.@ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")
@ApiImplicitParams({
@ApiImplicitParam(name="id", value="用户ID", required=true, dataType="Long"),
@ApiImplicitParam(name="user", value="用户详细实体user", required=true, dataType="User")
    })
@RequestMapping(value="/{id}", method=RequestMethod.PUT)
publicStringupdateUser(@PathVariableLongid, @RequestBodyUseruser) {
Useru=users.get(id);
u.setName(user.getName());
u.setAge(user.getAge());
users.put(id, u);
return"success";
    }
// 处理DELETE请求,用来删除User@ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")
@ApiImplicitParam(name="id", value="用户ID", required=true, dataType="Long")
@RequestMapping(value="/{id}", method=RequestMethod.DELETE)
publicStringdeleteUser(@PathVariableLongid) {
users.remove(id);
return"success";
    }
}

packagecom.yyg.boot;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
/*** @Author 一一哥Sun* @Date Created in 2020/5/13* @Description Description*/@SpringBootApplicationpublicclassRestfulApplication {
publicstaticvoidmain(String[] args){
SpringApplication.run(RestfulApplication.class,args);
    }
}