解决访问swaggerUI接口文档显示basic-error-controler问题

最新推荐文章于 2022-08-09 14:31:52 发布

转载最新推荐文章于 2022-08-09 14:31:52 发布 · 3.3k 阅读

文章标签：

#java #ui

本文介绍如何在SpringBoot项目中使用Swagger2生成美观且实用的API文档，通过配置排除错误路径并定制文档样式。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

问题描述

使用swagger生成接口文档后，访问http://localhost:8888/swagger-ui.html#/，显示如下：

有些强迫症的我，感觉看起来很不舒服，结果百度了好久，找到解决方案，刚接触spring boot对于很多api还不是很熟悉,先mark再说

代码如下：

package com.course.config;

import com.google.common.base.Predicates;
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;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .pathMapping("/")
                .select() // 选择那些路径和api会生成document
                .apis(RequestHandlerSelectors.any())// 对所有api进行监控
                //不显示错误的接口地址
                .paths(Predicates.not(PathSelectors.regex("/error.*")))//错误路径不监控
                .paths(PathSelectors.regex("/.*"))// 对根下所有路径进行监控
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("这是我的接口文档")
                .contact(new Contact("rongrong", "", "emai@qq.com"))
                .description("这是SWAGGER_2生成的接口文档")
                .termsOfServiceUrl("NO terms of service")
                .license("The Apache License, Version 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
                .version("v1.0")
                .build();
    }
}

　　重启服务：再次访问如下