スプリング+ Springfox +ヘッダパラメータ

Question

@RequestMapping(...) 
public Foo getFoo(@HeaderParam("header") final String header) { 
    ... 
} 

springfoxがそれをピックアップし、Iが闊歩-UIを見たときに、ヘッダのフィールドを有する上記のよう@HeaderParamメソッドパラメータを追加します。これはまさに私が欲しいものです。メソッド自体にパラメータを含めることなく、このヘッダパラメータをメソッドのセットに含めるようにspringfoxに指示する方法はありますか？私たちが実際に行っていることは、ヘッダーを使用するサーブレット・フィルターであり、swagger-uiを使用して簡単に設定できるようにしたいと考えています。

Answer 1

globalOperationParametersを使用することができます。例えば、

new Docket(...) 
      .globalOperationParameters(
     newArrayList(new ParameterBuilder() 
      .name("header") 
      .description("Description of header") 
      .modelRef(new ModelRef("string")) 
      .parameterType("header") 
      .required(true) 
      .build())) 

詳細については、ドキュメントの#22を参照してください。

Answer 2

つ以上の同一のための答えを説明した： -

@Bean 
    public Docket api() { 
     //Adding Header 
     ParameterBuilder aParameterBuilder = new ParameterBuilder(); 
     aParameterBuilder.name("headerName").modelRef(new ModelRef("string")).parameterType("header").required(true).build(); 
     List<Parameter> aParameters = new ArrayList<Parameter>(); 
     aParameters.add(aParameterBuilder.build()); 
     return new Docket(DocumentationType.SWAGGER_2).select() 
       .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build().apiInfo(apiInfo()).pathMapping("").globalOperationParameters(aParameters); 
    }