SpringBoot+Swagger2

原創

2020-02-22 06:31

pom.xml

<!--整合Swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

SwaggerConfig.java

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //當前包路徑
                .apis(RequestHandlerSelectors.basePackage("com.zouhongwei.myplus.myplusdemo"))
                .paths(PathSelectors.any())
                .build();

        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //頁面標題
                .title("learingDemo")
                //創建人
                .contact(new Contact("zouhongwei","url","email"))
                //描述
                .description("test")
                .termsOfServiceUrl("http://www.baidu.com")
                //版本號
                .version("1.0.1")
                .build();
    }
}

Controller

@RequestMapping("/api/user")
@RestController
@Api(tags = "user")
public class UserController {

    @Autowired
    private UserService userService;

    @ApiOperation("根據姓名查詢")
    @GetMapping("/selectbyname")
    public Result selectbyname(@ApiParam(name = "name") @RequestParam("name") String name){
        return ResultUtil.success("查詢數據成功",userService.selectUserByname(name));
    }

    @ApiOperation("根據年齡段查詢")
    @GetMapping("/selectbyagegroup")
    public Result selectbyagegroup(@ApiParam(name = "begin") @RequestParam("begin") Integer begin,
                                   @ApiParam(name = "end") @RequestParam("end") Integer end){
        return ResultUtil.success("查詢數據成功",userService.selectUserByAgeGroup(begin,end));
    }

    @ApiOperation("添加user")
    @PostMapping("/adduser")
    public Result adduser(@ApiParam(name = "json字符串")@RequestBody User user){
        userService.add(user);
        return ResultUtil.success("插入數據成功");
    }

}

訪問地址：