问题标签 [spring-auto-restdocs]

I use Java 8, Spring Boot 2.0, JUnit4. I try to make a proper documentation with Spring Auto REST Docs. Here is my dto:

Here is my controller method:

I finally here is my test:

So, the problem is that in my documentation fields Date rangeFrom and Date rangeTo in Request fields have String type but not Date. Also, in Request fields I don't have any description of my dto fields. Here my rest docs plugins in maven:

我是 Spring-Boot 的新手。我想将我的 REST api 文档从我的 Spring MVC 控制器自动生成到 RAML 中。有什么办法吗？或者我可以用它来将我的rest api生成到RAML中的任何指南？

我遇到了 Spring AutoRest Docs 的问题。似乎源于这段代码

完整配置：

我已经对杰克逊进行了一些定制，而 autorest 似乎不喜欢这样。当我输入 my 时objectMapper，我收到以下警告：

我尝试注入其他方法来获取对象映射器，包括

我也尝试过启动一个新的 Spring Boot 应用程序并且没有遇到任何错误。但是，如果prepareJackson删除没有更多警告，则自动生成的文档中没有数据。

我已经在这个问题上停留了很长一段时间，不知道如何解决它。任何指导将不胜感激。

我正在尝试在我的项目中设置 spring-auto-restdocs，该项目使用 JDK 11、Gradle 5、JUnit5 和 Spring Webflux 以及 spring boot 2.1.1。

我在这里遵循了正常的 spring-restdocs 设置指南：https ://docs.spring.io/spring-restdocs/docs/current/reference/html5/

然后也做了这个入门指南：https ://scacap.github.io/spring-auto-restdocs/

我的问题是，当我尝试运行以下 gradle 命令时： gradlew asciidoctor --stacktrace

我收到以下错误：

我有以下相关配置：

基础测试类：

spring-auto-restdocs 不能很好地使用这个设置还是我错过了什么？非常感谢任何帮助（特别是我们的测试人员，他们最终将获得某种体面的 api 文档：D 遗憾的是 springfox 不适用于 webflux 的功能路由）。

我正在使用 Spring REST Docs (2.0.3.RELEASE) 和 Spring Auto Restdocs (2.0.6) 来记录 REST API。

当请求包含一个没有赋值的查询参数（空字符串）时，片段由生成CliDocumentation.curlRequest()并HttpDocumentation.httpRequest()显示重复的参数。例如：

无论我这样做都会发生这种情况

或者

这类似于issue和duplicate，但是这只发生在无值参数上，并且提到的错误在 Spring REST Docs 的 1.1.2.RELEASE 版本中已修复。

注意：我认为问题不在于 Spring Auto Restdocs，因为这些是标准 Spring 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

有什么帮助吗？谢谢。

我有一个带有两个操作 /balance 和 /transactions 的 Rest 服务来获取客户的余额和交易。

此操作的返回类型是 BalanceResponse 和 TransactionResponse，这两种类型都是从 Response 扩展而来的

在记录 /balance 服务操作时，它还会在第二个 subType(TransactionResponse) 中列出响应字段。

如何仅显示与其返回类型对应的字段？如果它的 /balance 则显示（状态、余额和限制），并且如果它的 /transaction 仅在响应字段中显示（状态和交易列表）

有人可以让我知道如何处理文档中的基本继承类型

请在下面找到代码片段和 Auto RestDoc 生成的文档

在此处输入图像描述Auto RestDoc 响应字段

这是我在 StackOverflow 上的第一个问题。

我正在使用 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

文档的结构如下所示：

所有直接包含在Level 1 section.

对于里面的片段，Level 2 section一切都很好。

我理解为什么会出现警告，但是如何在自动生成的代码段中配置标题级别？

如果有办法将其配置为部分标题为 2 级，它可能会为Level 2 section(like expected level 3, got level 2) 中的片段显示警告。

有没有办法自动配置自动生成的片段中的部分标题级别？（基于包含的父节级别）

甚至是一种在每个单元测试中指定预期级别的方法。

我检查了文档，但没有找到任何东西。任何帮助表示赞赏。谢谢！

我使用 spring rest docs 来记录我的 api。

现在我想以以下形式记录我的文档我的路径

但我明白了

测试部分如下所示：

在我的 index.html 中，路径参数的记录与我期望的一样。我发现我的路径参数文档的表头正是我想要的方式：

所以看看默认的片段。在这里，我发现了以下内容：

因此，大括号似乎存在/存在问题。我试图将其复制到+{{path}}+自定义的 http-request.snippet 中。没有成功。我也尝试删除该nowrap选项，但同样，在路径中显示的值是变量名的插入。有人可以告诉我这里可能是什么问题吗？我希望我能提供足够的细节。

我在使用 Spring REST Docs 和阻止请求正文中的字段的深层文档时遇到问题：

和文档测试：

这个测试需要很多时间，输出如下：

root.childs[].childs[].childs[].childs[].childs[].childs[].path

我怎样才能防止这种情况？