阐明Spring Request参数

Question

我想用清晰的文字记录我的Spring api。 工作正常，但某些端点包含请求参数。 这些不会得到说明。

/**
 * 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);
}

加密文档将id记录为参数，而不记录requestParameter“ action”。 如何解决呢？

Answer 1

将@param添加到javadoc

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