Можем ли мы вывести аннотации swagger из классов контроллера или домена? - PullRequest
Новая
       72

Можем ли мы вывести аннотации swagger из классов контроллера или домена?

0 голосов
/ 03 мая 2020

Мы используем некоторые дополнительные аннотации, такие как @Api, @ApiOperation в наших классах контроллеров. Это делает наши классы менее читабельными, как вы можете видеть внизу. Не следует ли нам использовать эти аннотации для большей читабельности и принципа единой ответственности? Или все в порядке? Если это не очень хороший способ сделать это, как мы можем экстернализовать эти аннотации? 

@ApiOperation(value = "View a list of available products", response = Iterable.class)
@ApiResponses(value = {
        @ApiResponse(code = 200, message = "Successfully retrieved list"),
        @ApiResponse(code = 401, message = "You are not authorized to view the resource"),
        @ApiResponse(code = 403, message = "Accessing the resource you were trying to reach is forbidden"),
        @ApiResponse(code = 404, message = "The resource you were trying to reach is not found")
}
)
@RequestMapping(value = "/list", method= RequestMethod.GET, produces = "application/json")
public Iterable list(Model model){
    Iterable productList = productService.listAllProducts();
    return productList;
}
...