配置警告中不存在此类片段

Posted 2023-02-21

【中文标题】配置警告中不存在此类片段

【英文标题】：No such snippet is present in configuration warning

【发布时间】：2020-12-14 07:18:23

【问题描述】：

我正在使用 Spring rest auto docs 和 AsciiDoc 编写文档。以下是我的错误信息

错误信息

Section snippet 'auto-method-path' is configured to be included in the section but no such snippet is present in configuration

Section snippet 'auto-description' is configured to be included in the section but no such snippet is present in configuration

正在生成自动方法路径，所以我不知道警告来自哪里。但是自动描述是根据文档，控制器的javaDoc所以我不知道为什么没有生成这个文档。

JavaDoc

/**
   * Returns a Customer
   *
   * @param id       the id of the customer
   * @return the customer
   */
  @GetMapping(path = "api/customer/id", produces = HAL_JSON_VALUE)

【问题讨论】：

您是否忘记用双引号关闭您的路径字符串？

@ChrisMaggiulli 就在这里堆栈溢出！我手动重写了路径，因为原始路径包含我的公司名称。

【参考方案1】：

已修复。我在我的 Pom 上错过了这个：

   <execution>
            <id>generate-javadoc-json</id>
            <phase>compile</phase>
            <goals>
              <goal>javadoc-no-fork</goal>
            </goals>
            <configuration>
              <doclet>capital.scalable.restdocs.jsondoclet.ExtractDocumentationAsJsonDoclet</doclet>
              <docletArtifact>
                <groupId>capital.scalable</groupId>
                <artifactId>spring-auto-restdocs-json-doclet</artifactId>
                <version>2.0.9</version>
              </docletArtifact>
              <destDir>generated-javadoc-json</destDir>
              <reportOutputDirectory>$project.build.directory</reportOutputDirectory>
              <useStandardDocletOptions>false</useStandardDocletOptions>
              <show>package</show>
            </configuration>
          </execution>

【参考方案2】：

从您的 AutoDocumentation.sectionBuilder().sn-pNames(...) 中删除 SnippetRegistry.AUTO_METHOD_PATH 和 SnippetRegistry.AUTO_DESCRIPTION

// from
AutoDocumentation.sectionBuilder().snippetNames(
                    AUTO_METHOD_PATH,
                    AUTO_DESCRIPTION,
                    AUTO_AUTHORIZATION,
                    ...
                    ).build();

// to
AutoDocumentation.sectionBuilder().snippetNames(
                    AUTO_AUTHORIZATION,
                    ...
                    ).build();