Spring 自动休息文档中的自动部分标题级别
Auto Section title level in Spring Auto Rest Docs
这是我在 Whosebug 上的第一个问题。
我正在使用 Java 11,Spring Boot 2.4.0,JUnit 5,Auto Rest Docs 2.0.9。
我在生成文档时收到以下警告:
asciidoctor: WARNING: C:/{path-to-project}/build/generated-snippets/register_success/auto-section.adoc: line 2: section title out of sequence: expected level 2, got level 3
第 2 行如下所示:==== Register
文档的结构如下所示:
= API Methods
== Account Registration Operations
include::{snippets}/register_success/auto-section.adoc[]
== Other level 1 section
=== Level 2 section
include::{snippets}/{other-method-name}/auto-section.adoc[]
直接包含在 Level 1 section
中的所有片段都有警告。
对于 Level 2 section
中的片段,一切都很好。
我明白为什么会出现警告,但如何在自动生成的代码段中配置标题级别?
如果有办法配置它,使部分标题为 2 级,它可能会对 Level 2 section
(如 expected level 3, got level 2
)内的片段显示警告。
有没有办法自动配置自动生成的代码段中的章节标题级别? (基于包含在中的 parent 部分级别)
甚至是在每个单元测试中指定预期级别的方法。
我已经检查了文档,但没有找到任何东西。任何帮助表示赞赏。谢谢!
可以通过 Snippet customization, i.e. by providing a custom snippet template with the title on a different level. However, this would apply to all places. Alternatively, one could create a Custom snippet 配置标题级别,可以配置为使用不同的模板。主要问题是代码片段看不到周围的 AsciiDoc,因此永远不知道它在哪个级别。
这是当前的 Auto Section Snippet,标题在第三层。
我们尝试将所有片段放在同一级别。然而,这并不总是奏效或始终如一地应用。所以在实践中,我们会忽略这些警告。
这是我在 Whosebug 上的第一个问题。
我正在使用 Java 11,Spring Boot 2.4.0,JUnit 5,Auto Rest Docs 2.0.9。
我在生成文档时收到以下警告:
asciidoctor: WARNING: C:/{path-to-project}/build/generated-snippets/register_success/auto-section.adoc: line 2: section title out of sequence: expected level 2, got level 3
第 2 行如下所示:==== Register
文档的结构如下所示:
= API Methods
== Account Registration Operations
include::{snippets}/register_success/auto-section.adoc[]
== Other level 1 section
=== Level 2 section
include::{snippets}/{other-method-name}/auto-section.adoc[]
直接包含在 Level 1 section
中的所有片段都有警告。
对于 Level 2 section
中的片段,一切都很好。
我明白为什么会出现警告,但如何在自动生成的代码段中配置标题级别?
如果有办法配置它,使部分标题为 2 级,它可能会对 Level 2 section
(如 expected level 3, got level 2
)内的片段显示警告。
有没有办法自动配置自动生成的代码段中的章节标题级别? (基于包含在中的 parent 部分级别)
甚至是在每个单元测试中指定预期级别的方法。
我已经检查了文档,但没有找到任何东西。任何帮助表示赞赏。谢谢!
可以通过 Snippet customization, i.e. by providing a custom snippet template with the title on a different level. However, this would apply to all places. Alternatively, one could create a Custom snippet 配置标题级别,可以配置为使用不同的模板。主要问题是代码片段看不到周围的 AsciiDoc,因此永远不知道它在哪个级别。
这是当前的 Auto Section Snippet,标题在第三层。
我们尝试将所有片段放在同一级别。然而,这并不总是奏效或始终如一地应用。所以在实践中,我们会忽略这些警告。