Enunciate Spring Demande param

Question

Je voudrais documenter mon api de printemps avec enunciate. Fonctionne bien, mais certains points d'extrémité ont des paramètres de demande inclus. Ceux-ci ne seront pas documentés par énonciation.

/** 
* Does some magic. 
* 
* @HTTP 201 Successful Request. 
*/ 
@PostMapping(value = "/{id}", params = "action=doMagic") 
@RolesAllowed("ADMIN") 
public User restoreUser(@PathVariable Long id) { 
    User user = userService.restore(id); 
    return ResponseEntity.ok(project); 
} 

Le document enunciate documente l'ID en tant que paramètre mais pas le paramètre requestParameter. Comment cela peut-il être résolu?

Answer 1

Ajouter @param à javadoc

/** 
* Does some magic. 
* 
* @param action description of this parameter 
* @param id and you can describe id here too 
* 
* @HTTP 201 Successful Request. 
*/