spring boot 配置 swagger

一、依賴

            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.6.1</version>
                <exclusions>
                    <exclusion>
                        <groupId>com.google.guava</groupId>
                        <artifactId>guava</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.6.1</version>
            </dependency>

二、配置文件


@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api1() {
        //添加head參數start
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        tokenPar.name("token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("文檔1名稱接口")
                .enable(true)
                .apiInfo(apiInfo("接口1名稱", "1.0"))
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zy"))
                .paths(PathSelectors.regex("/path1.*"))//接口路徑前綴
                .build()
                .globalOperationParameters(pars);
    }

   @Bean
    public Docket api2() {
        //添加head參數start
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        tokenPar.name("token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("文檔2名稱接口")
                .enable(true)
                .apiInfo(apiInfo("接口2名稱", "1.0"))
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zy"))
                .paths(PathSelectors.regex("/path2.*"))//接口路徑前綴
                .build()
                .globalOperationParameters(pars);
    }

    /**
     * 創建該API的基本信息(這些基本信息會展現在文檔頁面中)
     * 訪問地址:http://ip:port/swagger-ui.html
     *
     * @return
     */
    private ApiInfo apiInfo(String title, String version) {
        return new ApiInfoBuilder()
                .title(title)
                .description("描述")
                .termsOfServiceUrl("https://baidu.com")
                .version(version)
                .build();
    }
	
}

3、訪問:http://ip:端口/swagger-ui.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章