Springfox: описание с заголовками

Question

Как мы можем получить несколько заголовков внутри описания следующим образом:

description: |
The Engine API  ....

# Errors

The API uses standard HTTP status codes ...


# Versioning

Some other text

В приведенном выше примере ошибки и управление версиями являются двумя заголовками.

В настоящее время я добавляю описание следующим образом:

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

Answer 1

Вы можете перейти с уценкой следующим образом:

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)