Swagger2 - 仅作学习与使用记录，若违规立删

1.Swagger2的依赖

<!-- swagger2 配置 -->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>
<!-- 下面依赖形成的文档，个人感觉清晰易懂些 -->
<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>swagger-bootstrap-ui</artifactId>
	<version>1.6</version>
</dependency>

2.Swagger2的基础配置（基于SpringBoot）

@Configuration
@EnableSwagger2
public class Swagger2Config {
    // swagger2的访问路径：http://localhost:8080/swagger-ui/index.html
	// xiaoymin的访问路径：http://localhost:8080/doc.html

    /**
     * 配置 swagger2 核心配置 docket
     * @return 核心配置
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)  // 指定api类型为swagger2
                    .apiInfo(apiInfo())     // 用于定义api文档汇总信息
                    .select()
                        .apis(RequestHandlerSelectors.basePackage("com.xxx.controller"))  // 指定controller路径
                    .paths(PathSelectors.any())     // 所有的controller
                    .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                    .title("Swagger2 接口api")    // 文档页标题
                    .contact(new Contact("联系人",
                            "网址",
                            "邮箱"))     // 联系人信息
                    .description("为前端提供的api文档")  // 详细信息
                    .version("1.0.1")      // 文档版本号
                    .termsOfServiceUrl("网站地址")    // 网站地址
                    .build();
    }
}