swagger2 灰小白的日常-- two

222 阅读1分钟

目的 : 可视化接口文档

spring boot集成swagger2

1.1 pom 中引入依赖

        <!-- 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>
        <!-- swagger2 引入-->

1.2 编写swagger2配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.context.request.async.DeferredResult;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

import static com.google.common.base.Predicates.or;
import static springfox.documentation.builders.PathSelectors.regex;

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket appApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("demo") //栏目名
                .genericModelSubstitutes(DeferredResult.class)
                .pathMapping("/")//根目录
                .select()
                .paths(or(regex("/v1/api/.*")))
                .build()
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts())
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("demo接口测试文档")
                .description("请关注:http://www.baidu.com/")
                .termsOfServiceUrl("http://www.baidu.com/")
                .contact(new Contact("zxh", "", ""))
                .version("1.0.0")
                .build();
    }
}

1.3 浏览器输入地址

http://{ip}:{端口}/swagger-ui.html 如:http://127.0.0.1:8087/swagger-ui.html