2017-01-04 4 views
0

enunciateでSpring APIを文書化したいと思います。正常に動作しますが、一部のエンドポイントには要求パラメータが含まれています。これらはenunciateによって文書化されることはありません。SpringのEnumiateリクエストparam

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

発音するのドキュメンタリーは、パラメータはありませんrequestParameter「アクション」としてのIDが記載されています。どのようにこれを解決することができますか?

答えて

0

のjavadoc

/** 
* Does some magic. 
* 
* @param action description of this parameter 
* @param id and you can describe id here too 
* 
* @HTTP 201 Successful Request. 
*/ 
に@paramを追加
関連する問題