Можно ли предоставить заметки Swagger @ApiOperation из файла в папке ресурсов - PullRequest
Новая
       12

Можно ли предоставить заметки Swagger @ApiOperation из файла в папке ресурсов

0 голосов
/ 13 сентября 2018

Я использую Swagger для документирования остальных конечных точек приложения Spring Boot.Ниже приведен пример некоторых конечных точек (просто для просмотра):

Часть apis.yaml : 

- endpoint: /api/v1.0/wagers/ats/{serialNumber}
  method: GET
- endpoint: /api/v1.0/wagers/ats/{gameId}/{drawId}/{couponNumber}
  method: GET
- endpoint: /api/v1.0/wagers/findsuccess
  method: GET
- endpoint: /api/v1.0/wagers/findsuccess/list
  method: POST

Так что я документирую конечные точки с помощью Swaggerкак показано ниже: 

@GET                                                                                                                    
@Path("/{serialNumber}")                                                                                                                                                                                        
@ApiOperation(value = "it is used to retrieve wager's data", notes = SwaggerNotes.SERIAL_NUMBER_NOTE, tags = "Wager operations V1.0")

, где SwaggerNotes - это просто Interface, который содержит всю документацию по Swagger.SwaggerNotes.SERIAL_NUMBER_NOTE выглядит следующим образом: 

public static final String WINNING_NOTES = "500 lines of html documentation text";

И охватывает более 5000 строк таких строк.

Итак, вопрос:

Как я могу загрузить строку вместо SwaggerNotes интерфейса из файла, скажем, /resources/SwaggerNotes.text or yaml или что-то еще?Возможно ли это с Swagger 2.0?

...