Swagger2 模擬請求頭

　　前幾天開發項目的時候，使用了Restful風格的接口。進行開發的時候，模擬請求頭，帶Token的時候遇到了一些問題。因為Api接口使用Swagger2進行搭建，所以找到了Swagger2 模擬header的方法。

　　注意，當header需要多個參數的時候，新建多個 ParameterBuilder，經過我的測試，重復使用一個ParameterBuilder會出現后面覆蓋前面的情況。　

package qqzsh.top.hd.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * @author zsh
 * @site www.qqzsh.top
 * @company wlgzs
 * @create 2019-05-28 21:34
 * @description Swagger2配置
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {

    /**
     * Restful風格的接口
     * @return
     */
    @Bean
    public Docket createRestApi(){

        //添加head參數配置start
        ParameterBuilder tokenPar = new ParameterBuilder();
        ParameterBuilder tokenPar2 = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("headerUserId").description("用戶ID").
43                 modelRef(new ModelRef("string")).
44                 parameterType("header").
45                 required(false).build();
        tokenPar2.name("headerUserToken").description("用戶token").
                modelRef(new ModelRef("string")).
                parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        pars.add(tokenPar2.build());

        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.basePackage("qqzsh.top.hd.controller"))
                .paths(PathSelectors.any()).build()
                .globalOperationParameters(pars);
56     }

    /**
     * 頁面顯示的開發者個人信息
     * @return
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("嗨抖短視頻API接口文檔")
                .contact(new Contact("zsh","http://qqzsh.top","[e-mail]"))
                .description("年輕人的歡樂短視頻社區")
                .version("1.0").build();
    }
}