SpringBoot 整合 Swagger2

1、加入 pom 文件

1        <dependency>
2            <groupId>org.springframework.boot</groupId>
3            <artifactId>spring-boot-starter</artifactId>
4        </dependency>
5        <dependency>
6            <groupId>org.springframework.boot</groupId>
7            <artifactId>spring-boot-starter-test</artifactId>
8            <!-- <scope>test</scope> -->
9            <exclusions>
10                <exclusion>
11                    <groupId>org.junit.vintage</groupId>
12                    <artifactId>junit-vintage-engine</artifactId>
13                </exclusion>
14            </exclusions>
15        </dependency>
16
17        <dependency>
18            <groupId>org.springframework.boot</groupId>
19            <artifactId>spring-boot-starter-web</artifactId>
20        </dependency>
21        <dependency>
22            <groupId>io.springfox</groupId>
23            <artifactId>springfox-swagger2</artifactId>
24            <version>2.9.2</version>
25        </dependency>
26        <dependency>
27            <groupId>io.springfox</groupId>
28            <artifactId>springfox-swagger-ui</artifactId>
29            <version>2.9.2</version>
30        </dependency>

2、配置Swagger2

1@Configuration
2@EnableSwagger2
3public class Swagger2Config {
4
5    @Bean
6    public Docket createRestApi(){
7        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
8                .select()
9                .apis(RequestHandlerSelectors.any())
10                .paths(PathSelectors.any()).build();
11    }
12
13    private ApiInfo apiInfo(){
14        return new ApiInfoBuilder()
15                .title("网站查询 API 文档")
16                .description("Desc.")
17                .version("1.0")
18                .build();
19    }
20}

3、写一个Controller测试：

1@Api(value = "网站")
2@RestController
3public class WebSiteController {
4
5    @ApiOperation(value = "检索", notes = "index")
6    @GetMapping(value = "/search")
7    public String search(@ApiParam(value = "keywords", required = true) @RequestParam String keywords) {
8        return String.format("%s-result", keywords);
9    }
10}

4、启动后界面