时间戳

首页 > 解决方案 > 在 Spring Auto Rest Docs 中自定义章节标题

spring-auto-restdocs - 在 Spring Auto Rest Docs 中自定义章节标题

问题描述

我想自定义auto-section.adoc[]Spring Auto Rest Docs 生成的文件中的“标题”部分。@titleSpring Auto Rest Docs 使用方法上的 Javadoc 标记（如果存在）或方法名称（如docs中所述）解析部分标题，但我不能包含@title在方法的 Javadoc 标记中，因为控制器类来自其他 JAR，我也不想要默认生成的方法名称。那么，如何在 Spring Auto Rest Docs 中自定义章节标题。

例如在自动生成的 auto-section.adoc[]

我不想

=== Resolved Method Name

我想

=== Something else

有什么帮助吗？谢谢。

标签： spring-auto-restdocs

解决方案

Spring Auto REST Docs 通过查看@title标签来确定标题，如果找不到，则采用方法名称。目前无法直接自定义此行为。如果您无法修改 Javadoc，就像您的情况一样，您必须通过片段添加信息。至少有两种选择：

  1. 创建自定义模板。但是您仅限于片段可用的信息，因此硬编码文本没有很多替代方案。见https://scacap.github.io/spring-auto-restdocs/#snippets-customization
  2. 创建自定义片段。这使您可以完全控制所有内容，因此可以创建一个片段，将“其他东西”作为输入并将其用作标题。请参阅https://scacap.github.io/spring-auto-restdocs/#snippets-custom创建自定义片段和https://scacap.github.io/spring-auto-restdocs/#snippets-section-custom-snippet在部分片段中包含自定义片段。

推荐阅读