一、認識swagger
swagger是什麼,就不多說了,可以參考部落格:http://blog.csdn.net/wangnan9279/article/details/44541665。它是一款API接口的管理工具,能夠識别具有RestFul風格的接口。 配置成功後,如下:
二、配置swagger
項目是基于Maven管理的SpringMVC工程:
首先,建立一個Maven工程:
填寫坐标資訊:
然後建立兩個module,分别作為web程式入口和配置swagger的子產品。
這時候,就可以删除根目錄下的src檔案夾,最後工程結構為(boot和common是兩個字子產品):
現在父pom檔案裡已經指定了這兩個子子產品,子子產品中也指定了父pom:
既然boot是作為程式入口,是以它的打包方式為war即可。
父子pom的層級關系已經确定下來,下面就是要指定具體的依賴。因為swagger是基于restful風格的api管理工具,是以項目要是springmvc架構的。 增加springmvc的依賴和對swagger的依賴:
父pom檔案:
<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.test.swagger</groupId>
<artifactId>swagger-parent</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>boot</module>
<module>common</module>
</modules>
<dependencyManagement>
<dependencies>
<!--java ee-->
<dependency>
<groupId>javax</groupId>
<artifactId>javaee-api</artifactId>
<version>7.0</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
</dependency>
<!--spring-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>4.3.6.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
<version>4.3.6.RELEASE</version>
</dependency>
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-staticdocs</artifactId>
<version>2.6.1</version>
</dependency>
<!--json-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.8.5</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
boot子子產品的pom檔案:
<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>swagger-parent</artifactId>
<groupId>com.test.swagger</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<packaging>war</packaging>
<artifactId>boot</artifactId>
<dependencies>
<!--spring-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
</dependency>
<!--jackson-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
<!--java ee-->
<dependency>
<groupId>javax</groupId>
<artifactId>javaee-api</artifactId>
<scope>provided</scope>
</dependency>
<!--common-->
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>common</artifactId>
<version>${project.parent.version}</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-staticdocs</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>
common子子產品的pom檔案:
<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>swagger-parent</artifactId>
<groupId>com.test.swagger</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>common</artifactId>
<dependencies>
<!--spring-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
<optional>true</optional>
</dependency>
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-staticdocs</artifactId>
<version>2.6.1</version>
<optional>true</optional>
</dependency>
<!--jackson-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<optional>true</optional>
</dependency>
<!--java ee-->
<dependency>
<groupId>javax</groupId>
<artifactId>javaee-api</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
</project>
boot作為web程式入口,其WEB_INF/web.xml檔案定義如下:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
version="3.0">
<!--Encoding Filter-->
<filter>
<filter-name>encodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!--Spring MVC-->
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:context-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
其中,web.xml檔案指定了springMvc的配置檔案為:類路徑下的context-mvc.xml。 context-mvc.xml配置為:
<?xml version="1.0" encoding="UTF-8"?>
<!--suppress UnparsedCustomBeanInspection -->
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!--配置-->
<mvc:annotation-driven/>
<!--元件-->
<bean class="com.swagger.test.common.RedirectCtr"/>
<context:component-scan base-package="com.swagger.test.controller"/>
<!--功能-->
<import resource="classpath:context/context-swagger.xml"/>
</beans>
其中第一條是指開啟注解功能,第二條注冊了一個bean執行個體,用來指定容器初始化後重定向的頁面資訊;第三條聲明了一個類路徑下的掃描器;第四條用于引入swagger的配置檔案context-swagger.xml。
RedirectCtr類如下:
package com.swagger.test.common;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author tian.lue
*/
@Controller
public class RedirectCtr {
@RequestMapping("/")
String redirect() {
return "redirect:/about.html";
}
}
它指定了重定向的路徑為about.html
context-swagger.xml檔案如下:
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<bean id="swaggerConfig" class="com.swagger.test.common.SwaggerConfig"/>
<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/>
<mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>
<mvc:resources mapping="/**" location="/static/"/>
</beans>
首先,它注冊了一個bean,用于配置swagger的基本資訊,然後指定了swagger的頁面(後面幾個不能随意改變)。 SwaggerConfig配置類如下:
package com.swagger.test.common;
import com.google.common.base.Predicate;
import org.springframework.context.annotation.Bean;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import static com.google.common.base.Predicates.or;
import static springfox.documentation.builders.PathSelectors.regex;
/**
* @author tian.luye
*/
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket selfCareApi() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("swagger")
.apiInfo(selfCareApiInfo())
.select()
.paths(selfCareApiPaths())
.build();
}
private ApiInfo selfCareApiInfo() {
return new ApiInfoBuilder()
.title("Test Swagger API")
.version("1.0-SNAPSHOT")
.build();
}
private Predicate<String> selfCareApiPaths() {
//noinspection unchecked
return or(
regex("/test.*")
);
}
}
這個配置類描述的非常清楚,隻配置了兩處資訊:一是Swagger的基本描述資訊,二是Swagger的攔截路徑,即加在類上的RequestMapping的path值。
最後,我們需要編寫Controller接口代碼
package com.swagger.test.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
/**
* @author tian.lue
*/
@RestController
@RequestMapping(path = "/test")
public class TestSwagger {
@RequestMapping(path = "/one", method = RequestMethod.POST)
public Object test() {
return null;
}
@RequestMapping(path = "/getRedis", method = RequestMethod.POST)
public String getRedis() {
return "asdasd";
}
}
運作後可以通過about.html中的超連結通路到配置好的Swagger頁面中: