我正在使用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有可能吗?