Spring + Springfox + Header Parametri

Question

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

Aggiunta di un parametro @HeaderParam metodo come sopra springfox lo preleva e quando guardo la spavalderia-ui ha un campo per l'intestazione. Questo è esattamente quello che voglio. C'è un modo per dire a springfox di includere questo parametro di intestazione su un insieme di metodi senza dover includere i parametri sul metodo stesso? Quello che stiamo realmente succedendo è un filtro servlet che usa l'intestazione e vorremmo che fosse facile impostarlo tramite swagger-ui.

Answer 1

È possibile utilizzare globalOperationParameters nella definizione del docket. Ad es.

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

Vedere #22 nella documentazione per ulteriori informazioni.

Answer 2

più quello spiegato risposta per stesso: -

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