问题标签 [spring-restdocs]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
8469 浏览

spring-restdocs - Spring Rest Docs 错误 - “由于输入结束,没有要映射的内容”

我有一个使用 Spring Rest Docs 的 Get 方法的测试用例。它运行良好。在 Post 方法上使用相同的代码样式,如下所示:

但是,我得到一个错误。

如果我在“andDo(..)”之后注释掉任何内容,那很好。这意味着问题出在文档部分。

什么不见​​了?

0 投票
1 回答
122 浏览

spring-restdocs - 使用 Spring Rest Docs 记录单值响应控制器

是否可以为返回单个值的控制器记录响应字段?

示例: [GET] /book/count

JSON响应: 1

0 投票
2 回答
925 浏览

spring-boot - 使用 Spring REST Docs 生成 Swagger 客户端

我看过这个 Spring REST Docs -视频

我们正在做 Spring boot 项目,并使用 springfox 库来生成 Swagger-ui 和 swagger 文档,如此处所述

我们喜欢 Spring Rest 文档可以为生成 REST API 文档所做的事情,以及我们不必在 Controller 代码中添加像 @ApiResponse 或 @ApiOperation 这样的大张旗鼓的注释这一事实。而且文档现在与代码一起存在的事实。

但是如果使用 Spring Rest 文档,我们将错过为我们的 API 自动生成的 Swagger-UI(当我们使用 swagger 集成时)。

Spring REST 文档是否可以生成像 Swagger UI 这样的测试 UI。

0 投票
1 回答
645 浏览

java - 如何将带有“包含”部分的 Asciidoc 文档编译成单个 adoc 文件

我正在使用spring-restdocs为项目生成文档。主asciidoc文档包括adoc描述request/response喜欢的其他片段:

我正在使用gradle并且asciidoc pluginspring 文档中所述。

有了这个,我可以运行gradle任务来生成完整的文档并获取html输出。

我想要做的是我想将此文档包含到github wikias 中asciidoc,这就是为什么我需要将完整文档编译到adocfile 而不是html. 有没有办法做到这一点?

0 投票
1 回答
480 浏览

spring-boot - Spring Rest 文档 - i18n 支持

我目前正在考虑如何为我的应用程序构建支持多种语言的 REST API 文档。端点、参数名称和返回值应该保持不变,但我想以不同支持的语言提供的每个 REST 方法的描述。

我使用 Spring boot、data & rest 并发现这个 docs 项目对我来说似乎非常有用。无论如何,我在文档中找不到任何关于 i18n 主题/支持的信息。

有人知道 Spring REST 文档是否支持生成多种语言的 API 文档(通常)?

0 投票
1 回答
893 浏览

spring-restdocs - 使用 Spring REST Docs 记录响应状态

我目前正在使用 Spring REST Docs 为我的 RESTful 服务生成文档,并且我想生成一个带有描述的响应状态的可能值表,就像在这里完成的一样(在页面底部)。

我可以在我的父index.adoc文件中手动执行此操作,其中包括生成的文件,但我不喜欢它,因为它使我的文档四分五裂,尽管我想将整个签名描述保存在一个地方。

我已阅读 REST Docs 文档并在 StackOverflow 和项目的 GitHub 问题上进行了搜索,但没有看到任何提及此类功能的内容。

我是否遗漏了什么,或者我正在寻找的功能没有实现甚至不需要?

0 投票
1 回答
851 浏览

asciidoctor - 如何在 Asciidoctor 中隐藏章节标题?

我已经搜索过了,但我找不到在主页上隐藏部分标题并仅显示在Table of Contents(:toc:) 中的方法。从此屏幕截图中可以看出,HomeTest是到 adoc 文件的外部链接。我只想将其保留在Table of Contents.

我知道可以Table of Contents通过使用 [discrete] 关键字来隐藏部分标题,但是可以反过来做吗?

这是此屏幕截图的 adoc 文件:

谢谢!

0 投票
1 回答
480 浏览

spring-restdocs - 有没有一种简单的方法可以在 spring-restdocs 中创建单个片段?

我刚刚深入研究了 spring-restdocs,我真的很喜欢记录我的 API 的方式。现在我想用python扩展生成的例子。意味着我想要像 curl 这样的片段,只适用于 python。

这是我到目前为止发现的:

我将不得不创建自己的模板,例如 default-curl-request.snippet。通过org.springframework.restdocs.snippet.TemplatedSnippet扩展我自己的实现是否正确?

0 投票
1 回答
1679 浏览

java - Spring REST Docs 抛出 MustacheException

在我的回复或请求中,我遇到了一个奇怪的异常,在不存在的字段上出现了问题。我有配置设置来为我的端点上的响应/请求生成片段,并带有关于这些 bean 字段的文档。除了我从org.springframework.restdocs.mustache包中得到以下异常;

'required'我的描述符片段或请求/响应 bean 中的任何地方都没有声明任何字段,这是怎么line 6回事?多么神秘的例外!这里有什么问题?

0 投票
3 回答
1182 浏览

spring - Spring REST Docs 中的文档图像响应

我有一个生成随机图像的 REST 端点。我正在使用 Spring REST Docs,但响应在 http-response.adoc 文件中都是乱码。Mock MVC 和 REST Docs 是否有一种简单的方法可以将文件存储在某处,以便我的 .adoc 文件可以引用它?