问题标签 [rspec-api-documentation]

我正在尝试将我的 API 文档与公共和开发人员文档分开，这样我就可以拥有可以提供给我以外的其他人的单独文档。

为此，我使用 Rails 和 gem 称为rspec_api_documentation，但是我无法让它工作。似乎 github 页面中提供的配置选项不起作用。

我首先尝试了自己的项目，然后检查了示例应用程序并在那里进行了修改：

验收助手.rb：

订单规格.rb：

输出：

我也尝试删除developers组，然后它没有给出任何错误，但是当我打开生成/doc/api/public/index.html它是一个空文件，上面写着“Example App API”。

任何帮助表示赞赏，谢谢。

我想手动序列化一个集合以进行测试。我试过这个：

这行不通。看来您只能在此处序列化单个资源。如何返回所有帖子的序列化集合？

我们正在使用rspec_api_documentation并设法使用以下代码为我们目前拥有的 2 个版本生成文档：

我们apitome用来渲染这些文档，但是，到目前为止，我们还没有找到一种方法来安装 API 2 的 2 个版本的路由。

有任何想法吗？

我刚刚开始使用 rspec_api_documentation 并且无法让它与我的 api 一起使用。创建了简单的规范，与自述文件中的第一个示例一样基本，但它不断向我抛出undefined method 'call' for nil:NilClass错误，我不知道可能导致问题的原因。

这是完整的堆栈跟踪：

这是规格

这是控制器

我的 api 在 localhost:3000/api/v1/users 下

任何帮助表示赞赏

我只想在开发环境中使用 swagger，但我想在生产部署时禁用此链接或禁用 swagger。我该怎么做？

我已经成功地使用rspec_api_documentationgem 为应用程序中的一些其他资源生成文档。

但是当我对新资源执行相同操作时，JSON 文件response_body是空的（尽管 JSON 的其余部分存在）。我不确定为什么会这样。

生成的 JSON 中的 response_body：

输出的 API 文档：

我做了什么：

• 用 a 测试了端点curl并可以确认它返回完整的响应（现在我只是在尝试构建文档）
• 已创建note_factory.rb
• 在开头的块中@notes = create_list(:note, 1,...)添加（并打印到控制台以确认它创建了一个对象）before(:all) donotes_spec.rb

也在下面创建作为测试。

我很困惑我可能会丢失什么导致相关的 JSON 响应RAD为空。

有没有人有任何想法可能导致这种情况？

按照使用 rspec_api_documentation 设置 aptitome的说明进行操作时，我收到以下错误：

我该如何解决？

我正在使用 rspec api 文档、apime 和 oauth2 协议来为我们的 api 构建验收测试。一切都很好，除了请求正文如下所示：

我从上面生成的文档中注意到：

我试图检查服务器上的参数

响应看起来像这样：

从我看到的服务器仍然以表单编码格式从客户端获取参数。

我的结论是，rspec api 文档没有将 content-type 作为 application/json 发送到服务器。

有什么我做错了或者需要采取什么其他步骤来使 rspec api 文档发送正确的内容类型（ application/json ）？

RspecApiDocumentation 中的资源可以有解释。但是在html 浏览器中使用json格式时它们不会显示。raddocs

例子：

user_spec.rb：

索引.json：

但是解释并没有出现在生成的 html 中：

我正在使用rspec_api_documentation和apitome来生成 api 文档。当我apitome在浏览器中查看输出时，有一个标题为“模拟响应”的链接。当我单击它时，我收到以下错误：

“模拟响应”有什么作用，我该如何解决这个问题？