springboot中使用Swagger2构建Restful风格API

在做项目中用到的Swagger2主要功能是：
1、用于测试。
2、写接口文档说明
直接上代码：
pom.xml配置 引入2个依赖：

<!-- restful风格swagger2 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.2.2</version>
		</dependency>

		<!--  下面2个依赖随便选一个即可，目前发现只是呈现的界面界面不同 -->
		<!-- 
		<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>swagger-bootstrap-ui</artifactId>
			<version>1.6</version>
		</dependency>
		 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.2.2</version>
		</dependency>

Swagger2类如下：

package com.syb;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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		//通过@Configuration注解，让Spring来加载该类配置
@EnableSwagger2		//通过@EnableSwagger2注解来启用Swagger2。
public class Swagger2 {


	/**
	 * 采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。
	 * @return
	 */
	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()	//select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现
				.apis(RequestHandlerSelectors.basePackage("com.syb.webapp"))
				.paths(PathSelectors.any())
				.build();
	}
	
	//apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）
	public ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("Spring Boot中使用Swagger2构建RESTful APIs")
				.description("更多Spring Boot相关文章请关注：http://blog.didispace.com/")
				.termsOfServiceUrl("http://blog.didispace.com/")
				.contact("孙大圣--程序猿之路！")
				.version("1.0")
				.build();		
	}
}

项目包结构如图：