spring3集成swagger2

前言：

    集成之前,首先一定要看清楚你所需要集成项目的spring版本。不同版本集成swagger不太一样。java本身就是一个高度依赖的语言。因此精准的搜索事半功倍。有些博客写的集成的是springfox-swagger2 我试了下,没有成功,可能是spring版本太低，暂时不去深究原因。可能集成很简单,但是其实做一个事情背后的思路更为重要。通过集成swagger我了解tomcat等容器自带的servlert名叫default,不同容器默认的不一样。反正可以学到很多,只可意会不可言传,正所谓师傅领进门,修行在个人.而不是简单的去学习配置。

下面这个网址可以很好的查看某个方法是不是在此当前spring版本里面

https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/util/MimeTypeUtils.html

我所集成的是3.2.8

pom文件增加依赖

<dependency>
    <groupId>com.mangofactory</groupId>
    <artifactId>swagger-springmvc</artifactId>
    <version>0.9.5</version>
</dependency>
<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>1.3.1</version>
</dependency>
<dependency>
    <groupId>com.mangofactory</groupId>
    <artifactId>swagger-springmvc</artifactId>
    <version>1.0.2</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.5.1</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.5.1</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>2.5.1</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.7</version>
</dependency>

是否全部需要,我也没有一一论证,但是我全部加上就是可以用的。

测试类

package com.iflytek.credit.platform.lsd.controller;

import java.util.ArrayList;
import java.util.List;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.annotations.ApiOperation;

@Api(value = "user")
@Controller
@RequestMapping(value = "/user")
public class UserController {


    @ApiOperation(value = "根据ID获取用户信息", httpMethod = "GET", notes = "根据username获取用户信息", response = List.class)
    @ResponseBody
    @RequestMapping(value = "/queryUser", method = RequestMethod.GET)
    public List<User> queryUser(@RequestParam(required = false, defaultValue = "a") String username) {
        List<User> userList = new ArrayList<User>();
        User u = new User();
        u.age = 11;
        u.nickName = "aa";
        u.username = "123123";
        userList.add(u);
        return userList;
    }
}

class User {
    public String username;
    public String nickName;
    public int age;

}

SwaggerConfig

package com.iflytek.credit.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
import com.mangofactory.swagger.models.dto.ApiInfo;
import com.mangofactory.swagger.plugin.EnableSwagger;
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;

@Configuration
@EnableSwagger
public class SwaggerConfig {

    private SpringSwaggerConfig springSwaggerConfig;
    /**
     * Required to autowire SpringSwaggerConfig
     */
    @Autowired
    public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {
        this.springSwaggerConfig = springSwaggerConfig;
    }

    /**
     * Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc framework -
     * allowing for multiple swagger groups i.e. same code base multiple swagger
     * resource listings.
     */
    @Bean
    public SwaggerSpringMvcPlugin customImplementation() {
        return new SwaggerSpringMvcPlugin(this.springSwaggerConfig).apiInfo(apiInfo()).includePatterns(".*?");
    }

    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfo(
                "springmvc搭建swagger",
                "spring-API swagger测试",
                "My Apps API terms of service",
                "12123123@qq.com",
                "web app",
                "My Apps API License URL");
        return apiInfo;
    }

}

 

spring-mvc的配置文件

<mvc:resources mapping="/swagger/**" location="/swagger/" />

<bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />
<!-- 将自定义的swagger配置类加载到spring容器 -->

<bean class="com.iflytek.credit.config.SwaggerConfig" />

 

web.xml

<servlet>
   <servlet-name>appServlet</servlet-name>
   <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
   <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:spring/servlet-context.xml</param-value>
   </init-param>
   <load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>
   <servlet-name>appServlet</servlet-name>
   <url-pattern>/</url-pattern>
</servlet-mapping>

去 github 找 3.0以下，2.0以上的ui 包，建议2.2.8以上,我这里下载的是https://github.com/swagger-api/swagger-ui/tree/v2.2.10

找到之后解压将 dist里面所有文件 放在 webapp/swagger/ 下面， 和 spring-mvc.xml 里的<mvc:resources  location="/xxxxx/"  保持一致； 

替换 index.html 里面的 “http://petstore.swagger.io/v2/swagger.json”为你当前项目路径“http://主机名或IP:端口/项目名/api-docs”，

启动服务器 jetty或者tomcat或者其他