SpringBoot 整合 Swagger2

1、加入 pom 文件


        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <!-- <scope>test</scope> -->
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2、配置Swagger2

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("网站查询 API 文档")
                .description("Desc.")
                .version("1.0")
                .build();
    }
}

3、写一个Controller测试：

@Api(value = "网站")
@RestController
public class WebSiteController {

    @ApiOperation(value = "检索", notes = "index")
    @GetMapping(value = "/search")
    public String search(@ApiParam(value = "keywords", required = true) @RequestParam String keywords) {
        return String.format("%s-result", keywords);
    }
}

4、启动后界面

来源：oschina

链接：https://my.oschina.net/u/240532/blog/4885955

标签

Spring Boot

swagger