Springfox：带标题的描述

Question

如何在描述中获取多个标题，如下所示：

description: |
The Engine API  ....

# Errors

The API uses standard HTTP status codes ...


# Versioning

Some other text

在上面的例子中，Errors和Versioning是两个headers。

目前我正在添加描述如下：

ApiInfoBuilder().description(" ... ")

Answer 1

你可以这样使用 markdown：

String description = "# The Engine API  ...\n" +
        "## Errors\n" +
        "The API uses standard HTTP status codes ...\n" +
        "## Versioning\n" +
        "Some other text\n";

\n 新行在这里很重要。

或者简单地使用普通 HTML:

String description = "<h2>The Engine API  ....</h2>" +
        "<h3>Errors</h3>" +
        "<p>The API uses standard HTTP status codes ...</p>" +
        "<h3>Versioning</h3>" +
        "<p>Some other text</p>";

然后将字符串添加到 API 信息中：

ApiInfoBuilder().description(description)

Springfox：带标题的描述

Springfox: Description with headings

swagger

springfox