Swagger使用（一）—— Springboot2.0与Swagger2整合生成在线接口文档（支持多文件数组上传）

    Swagger与Springboot项目进行集成很简单，首先就是添加一些maven的jar包依赖，然后添加一些swagger的相关配置，之后启用swagger在Controller的类或方法上添加一些swagger的描述信息，最后启动项目访问swagger的ui地址进行接口测试即可。具体步骤如下：

目录

一、POM依赖

二、添加Swagger的配置文件SwaggerConfig.java

三、在main方法中开启对Swagger的支持

四、创建一个Controller文件描述一些接口

五、启动项目后访问UI地址

六、Swagger中常用的一些注解

七、Swagger在使用中的一些常见问题

1、时间格式化问题

2、获取Swagger生成的接口json文档

3、利用Swagger插件自动生成html或pdf格式的接口文档

---

一、POM依赖

<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>

二、添加Swagger的配置文件SwaggerConfig.java

@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        //通过参数构造器为swagger添加对header参数的支持，如果不需要的话可以删掉
        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        ticketPar.name("loginToken").description("用户的Token信息")
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build(); //header中的loginToken参数现在设置为非必填，传空也可以
        pars.add(ticketPar.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //扫描的swagger接口包路径
                         .apis(RequestHandlerSelectors.basePackage("com.mengfei.learn.swaggercontroller")) 
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars); //不需要添加全局参数时这一行可以删掉
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Springboot利用swagger构建api文档")
                .description("简单优雅的restful风格 http://blog.csdn.net/")
                .termsOfServiceUrl("http://blog.csdn.net/")
                .version("1.0")
                .build();
    }

}

三、在main方法中开启对Swagger的支持

//启用Swagger2的配置
@EnableSwagger2
public class SpringbootApplication {

   public static void main(String[] args) {
      SpringApplication.run(SpringbootApplication.class, args);
   }
}

四、创建一个Controller文件