首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

当存在WebMvcConfigurationSupport时,不会生成Swagger UI

WebMvcConfigurationSupport是Spring MVC提供的一个配置类,用于自定义和扩展Spring MVC的配置。当我们在项目中自定义了一个WebMvcConfigurationSupport类,并且没有在其中配置Swagger相关的bean或者拦截器时,Swagger UI将无法生成。

Swagger是一种开源的规范和工具集,用于设计、构建、记录和使用RESTful风格的Web服务。它可以自动生成可交互式的API文档,提供可视化的界面来测试和调试API。Swagger UI是Swagger的一个重要组件,它可以根据Swagger规范的注解自动生成API文档并展示在一个友好的界面上。

在Spring Boot项目中使用Swagger通常需要添加相应的依赖和配置。如果存在WebMvcConfigurationSupport类且没有配置Swagger相关的bean或拦截器,Swagger UI将无法自动生成。

为了解决这个问题,可以在自定义的WebMvcConfigurationSupport类中添加Swagger相关的配置。具体的配置步骤如下:

  1. 添加Swagger的依赖:
代码语言:txt
复制
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger.version}</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${swagger.version}</version>
</dependency>
  1. 在WebMvcConfigurationSupport类中添加Swagger的配置:
代码语言:txt
复制
@Configuration
@EnableSwagger2
public class WebMvcConfig extends WebMvcConfigurationSupport {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

这样配置后,重新启动应用程序,Swagger UI将会生成并显示API文档。

推荐的腾讯云相关产品:腾讯云API网关。腾讯云API网关是一种支持云上和云下的高性能、高可靠、可扩展的API接口服务管理平台。具体产品介绍请参考:腾讯云API网关

注意:以上回答仅为参考,实际上需要根据项目具体情况进行配置和选择合适的腾讯云产品。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

OpenAPI规范3-Swagger2 的美化使用

如下图: 2、构建 通过生成服务器存根和来自swagger的规范的客户端sdk,构建并启用OAS/Swagger 的可编程语言。...3、Swagger UI Swagger需要在后台配置对于接口的相关信息并使用注解的方式将信息通过Swagger UI进行展示,自动生成了用于视觉交互的OAS规范中描述的所有文档,所以优点在于实时,减少沟通...或者说一个接口 @ApiOperation: 描述一个类的一个方法,或者说一个接口 @ApiParam: 单个参数描述 @ApiModel: 用对象来接收参数 @ApiProperty: 用对象接收参数,...UI的扩展 基于Swagger的注解将API个路径、描述、参数、返回值、异常状况等进行描述,swagger UI 模块仅仅是一个前端渲染框架。...swagger-ui-layer 的默认访问地址是 http://{host}:{port}/docs.html,而美化的界面如下: 和 2、Swagger-Bootstrap-UI Swagger-Bootstrap-UI

6.1K20

API管理-基于SpringBoot项目集成swagger实现接口文档自动生成

word来管理接口文档也没什么区别;而swagger却是通过开发者在编写接口的时候就已经通过指定的注解标注好接口的信息,在启动的时候swagger会自动生成对应的接口文档。...-- springfox-swagger原生ui --> io.springfox springfox-swagger-ui...总结 Swagger API 接口文档生成工具的利与弊,对于使用swagger利弊这边文章已经解释的很清楚了,虽然通过这种方式集成swagger后有一个统一的接口可以查看接口信息了,但这个springfox-swagger-ui...版本的并不支持接口文档的下载以便于离线查看,还有就是原生的ui使用起来总感觉不顺手,所以又有人基于swagger的接口方式自定义开发了基于bootstrap的ui并扩展了部分功能,详细请参考博客:API...管理-舍弃springfox-swagger-ui,采用功能更加丰富的swagger-bootstrap-ui

1.3K50

【WEB系列】高版本SpringBoot整合Swagger启动异常问题

解决方案 第一种,添加配置类 继承 WebMvcConfigurationSupport 重写 addResourceHandlers 方法。...) .addResourceLocations("classpath:/static/"); registry.addResourceHandler("swagger-ui.html...pathmatch: matching-strategy: ant_path_matcher 需要注意的是:这种方法无法彻底解决问题,只有在不使用 Spring Boot 的执行器,....java 文件复制到自己项目里进行修改,另一个大佬提了一个更好的解决方案,我觉得针不戳,在这里分享一下: 在你的项目里添加这个 bean :(加在配置类里就可)Spring Boot 2.6.x整合Swagger...start bean ‘documentationPluginsBootstrapper’ in spring data rest - Stack Overflow Spring Boot 2.6.x整合Swagger

2.1K30

swagger跨域,404,弹窗问题解决

} } 弹窗问题 如果你的项目运用了shiro或springsecurity等安全框架的,相信你应该知道我要说什么了,很明显你的资源肯定会被拦截掉,所以我们要将相应的资源打开,这里有两种 配置文件通过....xml 文件编写的 这里我们就只需要在过滤器链中添加以下代码即可 /v2/api-docs = anon /swagger-resources/configuration/ui = anon /swagger-resources...= anon /swagger-resources/configuration/security = anon /swagger-ui.html = anon /webjars/** = anon 配置文件通过.../**").permitAll() } 而且我建议你们使用2.7.0版本的Swagger,因为经过我自己的实践后发现2.9.2版本的确存在以下bug,我使用2.9.2的版本仍然出现弹窗,使用2.7.0版本后.../**","/swagger-ui.html/**","/swagger-resources/**"); super.addInterceptors(registry); }

2K10

swagger&knife4j

Swagger 方案一 一、认识Swagger 1.Swagger简介 Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。...2.Swagger主要功能 Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。功能主要包含以下几点: A....官网 : http://swagger.io/ Spring Boot & Swagger UI : http://fruzenshtein.com/spring-boot-swagger-ui/ Github...,更契合微服务架构,ui前身是swagger-bootstrap-ui,api注解的使用方式和swagger一致。...因为Swagger生成接口文档,就是根据这里指定的包路径,自动的扫描该包下的@Controller, @RestController, @RequestMapping等SpringMVC的注解,依据这些注解来生成对应的接口文档

46320

【三】springboot整合token

整合token,每次请求接口进行token效验,效验通过才可以请求到接口,我是通过jwt生成的token。token个人理解大概就是用来判断用户登录状态,是否已登录的。...此处token的生成方法以及效验方法可以根据具体情况进行更改,生成token1是使用的jwt,此处验证方法存在一个用户有多个token的情况(可以同时多次登陆同一账号,重新请求token之后,前一次的token...第五步:演示结果 1、请求没有放行的接口不带token请求: ​ 结果:会提示token效验失败。...2、请求放行的接口不带token请求: ​ 结果:成功请求到接口,此处是登陆接口,返回了token。...3、请求没有放行的接口带token请求: ​ 结果:成功请求到接口。 本期整合到此完毕,接下来会继续更新加强整合,尽情期待。

11210

Swagger异常定位纪实,是用的不对,还是Swagger本身设计问题

项目集成swagger后,可以生成导出open api v3格式化的元数据集,有了这个接口元数据,你可以在任何支持v3协议的ui上展示你的api信息。...swagger ui在解析注解标注的元数据信息,特别场景下会抛异常,而且抛的异常没有直观的有价值的异常信息,所以深入的debug了一番,虽然最后问题解决很简单,但是过程非常曲折。...并且是getExample抛出的异常,这里需要了解swagger ui的加载过程和基础架构才能直接定位。...结论及注意事项 Model作用于请求的接收参数,并且请求的类型为GET,那么Swagger Ui会自动收集Model所有属性的examole参数,因为这个参数是字符串类型,所以会做一个类型转换动作。...所以,需要注意的就是DTO作用于GET请求的接收参数,切记给所有的数值类型加上正确的example属性 后记 博主认为这里属于一个设计缺陷,而不是我们的使用问题。

17220

20201001_kpay支付项目搭建

搭建过程中遇到的问题 swagger访问404:根本原因module未生成target,需引入到其他模块中,其他原因springmvc拦截掉了swagger-ui.html的请求等 druid监控后台报...,上面的几个操作都是放在该module下,项目启动,新创建的kpay-config无法生成target,导致访问swagger-ui.html,一直报404 最后的解决办法:删除idea文件夹和各模块下的...image.png image.png 刚开始创建的时候,没有产生.iml文件 ,java目录也没变颜色,需要import一下pom文件 image.png 此时重新启动项目,kpay-generator模块下,不会生成...mapper 文件判断存在,不想重新生成返回 false return !...scan为true,此属性生效。默认的时间间隔为1分钟。 -->

1.3K31
领券