问题标签 [spring-restdocs]

Spring Boot 1.4 引入@AutoConfigureRestDocs（参见http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs）。文档状态：

它将自动配置 MockMvc 以使用 Spring REST Docs 并消除对 Spring REST Docs 的 JUnit 规则的需要。

我想使用 Spring REST Docs 的放心支持而不是 mockmvc。我可以这样做@AutoConfigureRestDocs吗？

我正在使用 Spring REST Docs 为我们的 API 生成文档。我已经从这里的教程http://docs.spring.io/spring-restdocs/docs/current/reference/html5/添加了所有内容到 build.gradle

完成后，gradle build我可以看到在build/asciidoc目录中生成了文件，并且在build/generated-snippets.

但是，当我从 IDEA gradle 任务运行bootRun并尝试访问 localhost:8080/docs/index.html 时，我找不到 404。只是为了测试，我尝试将一些index.html文件放在resources/static目录下，然后执行bootRun，我可以访问localhost:8080/index.html文件在那之后。

如果我打开我的 .jar 文件，我可以在目录下看到静态文件，BOOT-INF/classes/static/docs因此它们被打包到 jar 中。

也许有人有同样的问题？

我正在使用spring-boot-rest-docs生成 API 文档，我想从该文档链接到提供的文档spring-boot-actuator-docs以完成我的服务的可用端点文档。

问题是，当我包含推荐的运行时依赖项时，org.springframework.boot:spring-boot-actuator-docs它会用执行器文档覆盖我的/docs/index.html运行时端点。

是否可以将执行器文档配置为出现在不同的 URI 中，以便我可以从我自己的服务的 asciidoc 文档中超链接到它？

是否可以使用注释（在字段级别）为字段提供描述？

我知道我可以使用description方法

但我更愿意将该描述与字段定义放在我的响应对象中。

我知道我可以生成约束描述（http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#_using_constraint_descriptions_in_generated_snippets），但它只为验证注释生成描述。

我正在寻找来自 Swagger的类似https://github.com/swagger-api/swagger-core/wiki/Annotations#apimodelproperty的东西。

我的应用程序正在使用spring-data-rest和spring-restdocs。我的设置非常标准；几乎完全从文档中复制，但我已经包含了下面的示例，以防我遗漏了一些东西。当我的 mvc 测试运行时，它失败了：

这是我的测试代码：

这是堆栈：

我如何获得spring-restdocs并spring-data-rest玩得好？

我的documentation实例定义如下：

正如@meistermeier 指出的那样，（并遵循restdocs docs for ignoring links，我可以添加

但这仍然给我留下了：

似乎_links总是会将自我引用返回到同一个实体，对吧？如何在不忽略每个测试的实体特定链接的情况下干净地处理这个问题，例如：

即使我确实添加了上面的行（以便所有字段self _self curies和item都是ignored()和/或optional()），测试结果也会返回到该问题顶部的原始错误。

我使用 Spring RestDoc 和 AsciiDoc 来描述我的 rest api。RestDoc 根据是否有描述的请求参数/响应字段等生成不同的文件。我希望有一个模板有条件地包括存在的任何文件。

像这样的东西：

或者至少在文件丢失的情况下排除警告。但我不知道如何压制这些。

我正在使用 Spring MVC 和 Spring 测试套件（Spring REST Docs），我想知道在使用 MockMvcBuilders 构建 MockMvc 期间是否有办法在 asciidoctor adoc 文件中设置属性值？

例如我在 index.adoc

：我的属性：

并想在 MockMvc 构建期间动态设置它？

:myAttribute: myValue

我在 asciidoctor 文档中看到：

默认情况下，属性分配优先级从高到低依次为：

我想知道如何将它传递给 API :-)

在执行单元测试用例时，是否有任何机制可以关闭 Spring REST Docs 的片段生成（比如任何可以配置的标志）？

我不想在此处的每个单元测试代码级别进行更改。

在使用 Spring Boot 时，Spring Rest 文档 (spring-restdocs) 是 Swagger 的一个很好的替代品。将集成测试与 Rest 文档测试混合在一起，还是创建单独的 Rest 文档测试更好，即使某些测试是重复的？

您好我正在尝试使用 spring RestTemplate 在弹性搜索中搜索数据。ElasticSearch 有用户名和密码，我想通过 json 进行搜索。

我为此编写了代码，但没有得到任何结果或异常。我有生以来第一次这样做，如果其中有一些愚蠢的错误，我深表歉意。