使用springboot整合shiro后再整合swagger，及出现的URL [/swagger-ui] again. Check your ViewResolver setup!问题

最新推荐文章于 2024-05-16 15:12:52 发布

原创最新推荐文章于 2024-05-16 15:12:52 发布 · 5k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#springboot整合shiro、swagger及有的问题

springboot整合swagger 专栏收录该内容

1 篇文章

订阅专栏

本文详述了在SpringBoot项目中整合Swagger时遇到的循环视图路径问题及其解决方案，包括配置类、依赖添加、路径配置及Shiro权限管理下的资源开放策略。

首先，整合swagger的话很简单，这里首先说说之前出现的问题，

如果你加入了jsp及页面的跳转，这个时候很可能出现

Circular view path [swagger-ui]: would dispatch back to the current handler URL [/swagger-ui] again. Check your ViewResolver setup! (Hint: This may be the result of an unspecified view, due to default view name generation.)或者是

这个问题是你的页面在跳转的时候出现的问题，之前我也出现这种问题，原因是如下有的人说要加下面的一个类进行一个指定位置

@SuppressWarnings("deprecation")
@Configuration
public class WebMVCConfig extends WebMvcConfigurerAdapter {
    @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/");
//        registry.addResourceHandler("/**").addResourceLocations("classpath:/META-INF/resources/").setCachePeriod(0);
    }
}

其实，并不需要上边的那些注释位置，主要原因是我的controller中存在handler不能处理转发的路径，如下

       /**
		 * 页面转发, 显示main.jsp内置页面信息
		 */
		@RequestMapping("/commons/{path}")
		public String dispathcer(@PathVariable String path){
			return "commons/"+path;
		}
		
		/**
		 * 页面转发方法. 实现main.jsp显示
		 * @param path
		 * @return
		 */
		@RequestMapping("/{path}")
		public String toLogin(@PathVariable String path){
			return path;
		}

在这里发生了多次的页面的跳转，导致系统不知道如何跳转才出现Hint: This may be the result of an unspecified view, due to default view name generation.这个错误，当我把这个注释掉之后就可以显示swagger-ui.html了

1、在pom.xml文件中添加swagger依赖

	    <!-- 集成swagger接口文档 -->
	    <dependency>
	        <groupId>io.springfox</groupId>
	        <artifactId>springfox-swagger2</artifactId>
	        <version>2.8.0</version>
	    </dependency>
	    <!-- swagger-ui -->
	    <dependency>
	        <groupId>io.springfox</groupId>
	        <artifactId>springfox-swagger-ui</artifactId>
	        <version>2.8.0</version>
	    </dependency>

2、编写swagger配置类

@Configuration
@EnableSwagger2
@EnableAutoConfiguration
@ComponentScan("cn.zkhh.controller")
public class Swagger2 {

	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.zkhh"))
                .paths(PathSelectors.any())
                .build();
    }
	
	
	 //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot 测试使用 Swagger2 构建RESTful API")
                //创建人
                .contact(new Contact("贾洋洋", "https://blog.youkuaiyun.com/null111666", ""))
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

3、在启动类中要配置路径，以便可以扫描到swagger，并开启swagger的注解，如图

4、然后启动之后，访问地址http://localhost:端口/swagger-ui.html，即可，如图

5、如果你是使用springboot也整合了shiro的权限管理控制的话，就需要开放swagger的资源路径，否则也是访问不到swagger接口资源的，开发路径如下

        /**swagger拦截配置*/
        filterChainDefinitionMap.put("/swagger-ui.html", "anon");
        filterChainDefinitionMap.put("/swagger-resources/**", "anon");
        filterChainDefinitionMap.put("/swagger-resources", "anon");
        filterChainDefinitionMap.put("/v2/api-docs", "anon");
        filterChainDefinitionMap.put("/webjars/springfox-swagger-ui/**", "anon");

这样，在整合shiro后依然可以访问swagger