问题标签 [spring-restdocs]

作为开发人员，我更喜欢 spring restdocs。但作为文档的使用者，我发现大张旗鼓的实时文档非常引人注目。这是无处不在的例子： http: //petstore.swagger.io/

有没有办法用spring restdocs记录我的rest apis，但用它生成像swagger petstore这样的实时文档？如果是这样，你如何做到这一点？

如何在 Spring Restdoc 文档中设置上下文根？我在uris()寻找一种方法来设置它，但它不存在。

如果我直接将它添加到 mypost()中，我的测试会返回 404。

我尝试使用此处描述的属性方法， 但无法识别。也无法识别方法键。

我错过了静态导入吗？

我的代码：

我正在使用 spring-restdocs 生成 API 文档，并且我希望将所有参数、路径和响应字段 JSON 路径打印为表格内的代码部分（Asciidoc 中的反引号）。

例如，JSON 路径 sprockets.[].widgets.[].contentType 比以等宽字体sprockets.[].widgets.[].contentType打印的可变宽度字体更难阅读。

请求参数和路径参数也是如此——这些是应该以等宽字体打印的标记。

使用 Spring-restdocs 实现这一目标的最简单方法是什么？

提前感谢您的帮助。

G

我将 spring 单元测试与 spring-restdocs 一起使用。

这是我的 mockmvc 代码：

但是当使用 spring-restdocs 时，我不知道如何编写文件片段。

这是我的片段创建代码：

这样我得到一个错误：

我正在使用 Spring Restdocs 获取文档。这是我的代码：

.adoc 文件已成功生成，并且出现我正在努力解决的错误。

我认为问题来自

由于我将其注释掉，因此错误消失了。但是 JSON 响应没有按我预期的那样格式化。我真的很感谢你的帮助。提前致谢。

I am using preprocessResponse to format JSON response. I works fine with small JSON data.

small JSON data

On the other hand, problem happens when i work with huge JSON data response. It fails in build process with error below

Here's my snippet code:

I can solve the problem and make a build run successfully by commenting out

or

but JSON data response is not formatted as i expect. I'm new to spring-restdocs so your help means a lot to me. Thank you in advance.

我正在从头开始构建一个 API 并使用 Spring Rest Docs (1.0.1) 对其进行记录，目前没有特定 API 的响应字段。

我意识到我可以在 .adoc 文件中手动记录这一点，但如果稍后我们推进 API 和响应字段发挥作用，我希望单元测试启动并提醒我需要更新。

当我尝试：

或者

我收到以下错误：

我正在为返回如下对象的 REST 服务做文档：

而且我找不到描述此类对象的响应字段的方法。

让我们看看我的代码。

服务：

我的基于单元测试的文档：

如您所见，响应字段的代码已被注释掉，因为我还没有任何解决方案。我正在努力，但我非常感谢你的帮助。先感谢您。

我正在尝试将 Spring REST 文档与 Grails 3.1.4 应用程序放心集成。我正在使用 JSON 视图。

完整代码在https://github.com/rohitpal99/rest-docs

在我使用 NoteController 时

文档生成效果很好。

但我想使用 JSON 视图，如

我在 /views 目录中有 _notes.gson 和 index.gson 文件。我得到一个 SnippetException。通常的 /notes GET 请求响应是正确的。

没有消息。无法追踪它发生的原因。请建议。

完整的堆栈跟踪