Spring + Springfox + Header-Parameter

Question

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

Hinzufügen eines @HeaderParam Methodenparameter wie oben springfox es aufgreift und als ich an der Prahlerei-ui suchen hat es ein Feld für die Kopfzeile. Das ist genau was ich will. Gibt es eine Möglichkeit, Springfox zu sagen, diesen Header-Parameter in eine Reihe von Methoden aufzunehmen, ohne die Parameter in die Methode selbst aufnehmen zu müssen? Was wir wirklich machen, ist ein Servlet-Filter, der den Header verwendet und wir möchten, dass er einfach durch den Swagger-Ui gesetzt wird.

Answer 1

Sie konnten die globalOperationParameters in der docket Definition verwenden. Für z.B.

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

Siehe #22 in der Dokumentation für weitere Informationen.

Answer 2

Eine weitere erklärt Antwort für gleiche: -

@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); 
    }