Включая уценку или документ html в верхней части сгенерированного Swagger в Quarkus - PullRequest
Новая
       38

Включая уценку или документ html в верхней части сгенерированного Swagger в Quarkus

0 голосов
/ 22 апреля 2020

У меня длинный документ с подробным описанием API ReST и его использования. Как я могу включить это в сгенерированное чванство, чтобы содержимое находилось в верхней части чванства? При ручном создании сайта-сваггера с OpenAPI вы можете сделать это: 

Info info = new Info().description(getFileContentsOnClasspath("/docs/docs.md"));
OpenAPI oas = new OpenAPI();
oas.info(info);

Возможно, есть способ сделать подобное с Microprofile / Quarkus, в отличие от этого, который просто предоставляет ссылку, а не встраивание содержание: 

@OpenAPIDefinition(info = @Info(title = "XXX", version = "3.0.0", description = "ABC"), externalDocs = @ExternalDocumentation(url = "../../docs.html"))

Может быть что-то вроде: 

@OpenAPIDefinition(info = @Info(title = "XXX", version = "3.0.0", description = "ABC"), embedDocs = @ExternalDocumentation(url = "../../docs.html"))
...