问题标签 [rspec-api-documentation]

我在 5.2 版 ruby​​ on rails 应用程序中使用rspec_api_documentationand apitomegems。

这会产生出色的文档，并有一个侧边栏 (div#sidebar) 允许快速访问文档的正确部分。当我选择

初始化程序中的选项apitome.rb，文档被渲染，但侧边栏消失了。查看页面源代码，侧边栏的代码没有被渲染，即不是css问题，html没有被放入布局中。为了确保它在我的 application.html.erb 文件中没有异常，我将其简化为

这个侧边栏非常有用，那么如何在布局中呈现它呢？

我现在正在使用 spring rest docs，我收到下一个错误：

事实上，当我调试测试时，我已经看到内容是空的。这是我的测试：

这是我从调试中得到的：

但我可以在模型和视图端看到我的模拟响应信息：

我的控制器方法返回一个对象，就像：

并且由于某种原因，框架没有正确地进行映射，知道是否可以将此信息设置为内容响应，或者我是否可以创建一个自定义的 FieldDescriptor 来面对这种情况？

谢谢

我正在为我的 rails 应用程序使用RSpec API 文档生成器 Gem，当我生成文档时，请求正文（JSON 格式）的格式如下：

有没有办法像下面这样漂亮地打印它？

我似乎找不到任何配置选项来做到这一点。我正在使用以下两个标题：

我的目标是使用带有 rswag-ui 的 rspec_api_documentation 或通过将 swagger-ui 直接添加到项目中来显示参数和响应的多个示例。我在使用我的配置生成正确的 open_api.json 时遇到了一些问题，我想知道我做错了什么。

宝石：

• https://github.com/zipmark/rspec_api_documentation
• https://github.com/rswag/rswag

用于测试的 rspec_api_documentation 配置：

OpenAPI 配置：

示例测试：

生成的输出：

期望的输出（至少我认为）：

在降价模式下使用rspec-api-documentationconfig.format = [:markdown] gem 时 ( ) 我注意到生成的文档缺少响应正文。

是否有永久修复此问题的方法？

我想通过 Apitome 渲染这些，但它们只返回 http。我可以设置其他标题：

但是当我放弃header 'HTTP_CODE', 'https'它时，它会把它擦掉，所以它要么是钥匙的问题，要么是我走错了路。试图避免任何猴子修补，但欢迎任何提示！

我正在处理我实现的搜索端点的测试和文档。我无法正确添加查询参数。基本上请求 url 应该是这样的

我的控制器看起来像这样

该功能可以正常工作。问题在于测试。这是规范文件的样子：

运行 rspec 时出现的错误是