spingmvc+swagger2整合问题记录

背景描述:最近接手了个springboot +vue前后端分离的项目。 里面引用到了swagger，方便给前端的小伙伴暴露接口，联调开发。

但是呢，接手的项目有几个是没有坑的呢。 这个项目连登录都没有。 所以 现在需要把springboot里做好的接口和其他一些东西整合到另一个 脚手架框架里（老版本的 jeesite 。感兴趣的小伙伴可以了解下。项目结构是springmvc +shiro+mybatis）...好了，多余的话留到后面说，现在记录下过程中产生的问题。

搭建过程描述：jdk1.8+maven3.6+ spring 4.3.6

1. myeclipse maven创建一个简单的 springmvc 项目 
2. 配置web.xml 、pom.xml、spring-mvc(这个名字可以随便取，和web.xml中配置的保持一致就i行了) 文件
3. swagger的配置类
4. 编写controller类，类和 方法上加上swagger相关的注解
5. 访问 http://localhost:port/项目名/swagger-ui.html 验证自己的配置

 

 

Q1： 出现下面弹窗  。 参考了网上好多小伙伴的回答，原因：spring没有把配置的swagger文件管理起来。

        解决:在 spring-mvc.xml 中配置编写的ApiConfig类 <bean class="xx.yy.ApiConfig[这里是类的全路径]" id="ApiConfig"></bean>

Q2: 页面中常访问，但是对应的 Controller 前面的说明没有显示。网上也没有找到相关的回答。 对应的配置，controller类上的@Api(tag=”类描述“ )注解 也是有的。 然后排查问题中... 一开始以为是pom.xml中 jar包冲突，一个个在那删掉 排查,然无果。 后来注意到 controller类中的方法上用的是 @GetMapping注解。

 解决：要改成  @RequestMapping注解，并在swagger注解 @ApiOperation中指定 httpMethod请求类型。

不清楚具体是因为什么导致的，麻烦知道的小伙伴告知一下。谢谢。

此时会看到下方第二张图

@Api(tags="用户模块")
@RestController
@RequestMapping(value = "/test")
public class TestController {

	/**
	 * 注意下面要用@RequestMapping注解，并在swagger注解 @ApiOperation中指定 httpMethod请求类型
	 */
	@GetMapping(value = "/findUser")
	@ApiOperation(value = "查看用户" ,httpMethod="GET")
// 	@RequestMapping(value = "findUser" )
	public String findUser(){
		System.out.println(123);
		return "333";
	}
}

 

 

完整的代码文件在下面。 源码在 https://github.com/freekai777/springmvcAndSwagger2.git

 

项目结构

 

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee"
	xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	version="2.5">
	<display-name>Archetype Created Web Application</display-name>


	<servlet>
		<servlet-name>spring</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<init-param>
			<description>Servlet Context</description>
			<param-name>contextConfigLocation</param-name>
			<param-value>classpath:spring-context.xml</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>spring</servlet-name>
		<!-- 拦截所有请求 -->
		<url-pattern>/*</url-pattern>
	</servlet-mapping>
</web-app>

spring-context.xml 对应着web.xml中 servelet中的 classpath:spring-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:task="http://www.springframework.org/schema/task"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd
		http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd 
		http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.1.xsd">

	<description>Spring MVC Configuration</description>

	<!-- 对静态资源文件的访问， 将无法mapping到Controller的path交给default servlet handler处理 -->
	<mvc:annotation-driven/>
	<mvc:default-servlet-handler />
	
 	<!-- 注入swagger -->
 	<bean class="com.fellakai.config.ApiConfig" id="ApiConfig"></bean>
 	<!-- 扫描controller -->
    <context:component-scan base-package="com.fellakai.controller"></context:component-scan>

	 <!-- 引入swagger相关 ，注意静态资源文件映射是否打开-->
    <mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/" />
    <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/" />

	<bean
		class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
		<property name="exceptionMappings">
			<props>
				<prop key="org.apache.shiro.authz.UnauthorizedException">error/403</prop>
				<prop key="java.lang.Throwable">error/500</prop>
			</props>
		</property>
	</bean>


</beans>

pom.xml 

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.fellakai</groupId>
  <artifactId>spingmvc</artifactId>
  <packaging>war</packaging>
  <version>0.0.1-SNAPSHOT</version>
  <name>spingmvc Maven Webapp</name>
  <url>http://maven.apache.org</url>
  <dependencies>
	    <dependency>
	      <groupId>junit</groupId>
	      <artifactId>junit</artifactId>
	      <version>3.8.1</version>
	      <scope>test</scope>
	    </dependency>
    
    	<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-webmvc</artifactId>
			<version>4.3.6.RELEASE</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
		<dependency>
		    <groupId>com.fasterxml.jackson.core</groupId>
		    <artifactId>jackson-databind</artifactId>
		    <version>2.9.5</version>
		</dependency>
		
		<!-- swagger2核心依赖 -->
 
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.7.0</version>
		</dependency>
 
		<!-- swagger-ui为项目提供api展示及测试的界面 -->
 
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.7.0</version>
		</dependency>
  </dependencies>
  <build>
    <finalName>springmvc</finalName>
  </build>
</project>

ApiConfig.java  swagger 配置类 

package com.fellakai.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import io.swagger.annotations.ApiOperation;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration //这个注解好像没有用。注释与否都没啥影响
@EnableWebMvc
@EnableSwagger2
public class ApiConfig {
	@Bean
	public Docket customDocket() {
		
		return new Docket(DocumentationType.SWAGGER_2).select().
				apis(RequestHandlerSelectors.any()).
//下面是过滤到 ApiOperation注解的方法。 也可以用到包过滤，在下面注释掉了。
				apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).
//				apis(RequestHandlerSelectors.basePackage("com.fellakai")).
				build().apiInfo(apiInfo()); //括号中的调用下面的 apiInfo 方法
	}

	ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("一级标题").description("二级标题").version("版本号v1.0")
				.build();
	}
}

TestController.java  controller 

package com.fellakai.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

@Api(tags="用户模块")
@RestController
@RequestMapping(value = "/test")
public class TestController {

	/**
	 * @ApiOperation 这个注解是指该方法是用来做什么的,一定要加上httpMethod,否则会出现一堆
	 * @param userVo
	 * @return
	 */
	//@GetMapping(value = "/findUser")
	@ApiOperation(value = "查看用户" ,httpMethod="GET")
 	@RequestMapping(value = "findUser" )
	public String findUser(){
		System.out.println(123);
		return "333";
	}
}