在springfox-swagger-ui中渲染html

Question

我最近更新了运行springfox-swagger2和springfox-swagger-ui 2.5.0的应用程序以使用2.6.0版。该应用程序的API文档使用<li>，<b>和<br>标记，这些标记使用2.5.0正确呈现，但版本2.6.0使用<li>和swagger-ui会忽略<br>个标签。

我需要做些什么才能让springfox再次渲染HTML标签？

标签用于以下位置：

ApiInfoBuilder().description("HERE")

@ApiOperation(notes="HERE")
@ApiResponse(message="HERE")

Answer 1

在尝试@ApiOperation注释后，我发现在2.7.0版本中，SpringFox支持Markdown语法进行文本格式化（就像Stack Overflow，GitHub，Atlassian等）。请参阅任何Markdown语法指南以供参考。

我的实验表明，这个Swagger注释和下面的YAML定义应该是等价的。

@ApiOperation(value = "Markdown in Swagger API descriptions",
    notes = "#Head 1 \n## Head 2 \n###Sorting rules\nThe data is sorted by priority (from the highest to the lowest).<br/> Unordered list \n * item 1.\n * <b>bold item 2</b>\n")

=

summary: Markdown in Swagger API descriptions
description: <h1>Head 1</h1><h2>Head 2</h2><h3>Sorting rules</h3>
             The data is sorted by priority (from the highest to the lowest).<br/> Unordered list
             <ul><li>item 1.</li><li><b>bold item 2</b></li></ul>

注释在Swagger-UI

中生成此输出

  

如何让SpringFox再次呈现HTML标记？

您必须将API说明翻译为Markdown。