springmvc禁用swagger-ui

时间: 2023-09-08 19:02:59 浏览: 269

Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题

主要介绍了Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题及解决方法，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下在Spring Boot应用中，Swagger是一个强大的工具，它可以帮助开发者生成、描述、测试和展示RESTful API。Swagger UI是Swagger的一部分，提供了一个用户友好的界面，允许用户交互式地浏览和测试API。然而，在Spring Boot中引入Swagger UI时，有时会遇到访问`swagger-ui.html`返回404错误的问题。以下是对这个问题的详细分析和解决方案：要引入Swagger的相关依赖，需要在项目的`pom.xml`文件中添加Springfox的`springfox-swagger2`和`springfox-swagger-ui`两个依赖项，如下所示： ```xml <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> ``` 接下来，创建一个配置类`Swagger2Config`，使用`@EnableSwagger2`注解开启Swagger功能，并通过`@Bean`方法定义一个Docket实例，来指定需要扫描的API路径： ```java @Configuration @EnableSwagger2 @Profile("swagger") @ComponentScan("xxx.controller") public class Swagger2Config { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .enable(true) .select() .apis(RequestHandlerSelectors.basePackage("xxx.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("XXX Rest Server") .description("XXX Rest接口") .contact(new Contact("contract", "url", "email")) .version("1.0") .build(); } } ``` 当访问`swagger-ui.html`出现404错误时，通常是因为Spring Boot的静态资源处理配置问题。在某些情况下，如果项目中存在自定义的`WebMvcConfigurer`，可能会覆盖默认的静态资源处理，导致Swagger UI的资源找不到。为了解决这个问题，可以在`WebMvcConfig`类中覆盖`addResourceHandlers`方法，显式地添加Swagger UI的资源路径： ```java @Configuration public class WebMvcConfig implements WebMvcConfigurer { @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/**").addResourceLocations("classpath:/static/"); registry.addResourceHandler("swagger-ui.html") .addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars/"); } } ``` 这样，Swagger UI的静态资源就可以被正确地加载，从而可以正常访问`swagger-ui.html`。除此之外，为了使前端更好地利用Swagger生成的API文档，可以考虑使用前端库（如Vue.js的typescript版本）来自动化生成调用API的代码。例如，可以参考文章中提到的开源npm库，以便前端使用axios更方便地调用API。总结来说，解决Spring Boot引入Swagger UI后`swagger-ui.html`无法访问的问题，关键在于正确配置Swagger的依赖和自定义`WebMvcConfigurer`以处理Swagger UI的静态资源。同时，为提升开发效率，前端可以利用相关工具自动根据Swagger生成的API文档构建调用代码。通过这些步骤，可以确保Swagger在Spring Boot项目中的顺畅使用，提高API的开发和测试效率。

要禁用Spring MVC中的Swagger-UI，可以按照以下步骤进行操作： 1. 首先，打开项目的配置文件（一般为application.properties或application.yaml）。 2. 在该配置文件中，找到Swagger-UI相关的配置项，一般以"springfox.documentation"开头。可以使用Ctrl+F来搜索。 3. 要禁用Swagger-UI，需要将对应的配置项设置为false。例如，在application.properties中，可以将以下配置项设置为false： springfox.documentation.swagger-ui.enabled=false 4. 保存并关闭配置文件。 5. 重新编译和部署项目，确保应用程序使用了最新的配置。 6. 禁用成功后，重新启动应用程序，并访问Swagger-UI的URL（一般为http://localhost:8080/swagger-ui.html）来验证是否禁用成功。这样，就成功禁用了Spring MVC中的Swagger-UI。请注意，禁用Swagger-UI可能会导致一些功能失效或不可用，因此在禁用之前，请确保了解其影响及可能带来的问题，并根据实际需求进行操作。

阅读全文

springmvc禁用swagger-ui

相关推荐

springmvc与swagger swagger-ui 集成demo

springmvc集成swagger-ui

springfox-swagger-ui和swagger-bootstrap-ui和springfox-swagger2三者的区别

swagger-springmvc-example:SpringMVCSwagger集成的样本项目

springmvc集成swagger

springmvc整合mybatis-plus

springmvc使用 dynamic-datasource

springmvc的WEB-INF

springmvc整合swagger2

springmvc 配置Swagger2

springMVC项目如何整合thymeleaf和element-ui

springmvc怎么关闭swagger

用swagger-maven-plugin生成接口文档swagger.json或者swagger.yaml

springmvc+mybatis-plus+layui写一个后台管理系统

SpringMVC：流程-1个核心、3大组件

springMVC context:component-scan

springmvc-config

springmvc配置HTTP Strict-Transport-Security

springmvc-servlettomcat

最新推荐

Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题

SpringMVC如何在生产环境禁用Swagger的方法

springmvc转为springboot--干货.docx

Springboot引入拦截器并放行swagger代码实例

SpringMVC Tomcat控制台乱码问题解决方案

MATLAB实现小波阈值去噪：Visushrink硬软算法对比

管理建模和仿真的文件

【交互特征的影响】：分类问题中的深入探讨，如何正确应用交互特征

c语言从链式队列 中获取头部元素并返回其状态的函数怎么写

易语言实现画板图像缩放功能教程

c语言从链式队列中获取头部元素并返回其状态的函数怎么写