问题标签 [rswag]

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 回答
803 浏览

ruby-on-rails - rswag rails gem,无法识别我创建 swagger.yml 的模式

通过考虑上面的代码,swagger.YAML 文件生成为空的。那么我必须如何使用模式?

0 投票
1 回答
139 浏览

ruby-on-rails - 为 rswag 运行 rspec 时,键和值在参数中连接在一起,因为键和值变为 nil?

通过考虑上面的代码,参数将是这样的:

所以 search 和 faker:name.first_name 附加在 params 作为键,但我希望 search 成为键,faker 成为值。

0 投票
1 回答
194 浏览

ruby-on-rails - 不需要在每个 rswag 响应块中调用参数

我不想在第一个响应参数中传递搜索参数,但在最后一次通知中产生了一个错误:如果通过 nil 传递参数,在控制器中作为长度为零但仍然存在的字符串存在?是真的

0 投票
1 回答
1376 浏览

ruby-on-rails - rswag gem:响应块中模式的主要目的是什么?

上面代码中的关键字模式对我们有什么好处?真实的反应与此相比吗?如果不匹配,引发错误?

0 投票
0 回答
386 浏览

ruby-on-rails - 如何在 rswag 中创建 DELETE 销毁操作?

我是 rswag 的新手。我正在尝试使用它来生成登录和注销路径。我可以为 /login 创建一个集成文件。但是注销让我抓狂:

这是我的 rspec 注销测试(有效)

我一直在寻找有关如何在 rswag 中管理销毁方法的文档,但没有任何用处。如何在我的 rswag 规范中创建这个 DELETE destroy 方法?

0 投票
2 回答
1998 浏览

ruby-on-rails - 使用 rswag 跟随 JSON Api

我正在使用rswag测试一个相当常见的 RubyOnRails JSON Api应用程序,但我无法弄清楚我将文件上传到端点的一个相当常见的情况。

端点期望data请求正文中的常用属性具有file包含二进制文件的属性,并且我无法使 rswag 生成具有正确参数的请求。

还有一些其他更简单的参数(例如授权)是正确生成的,我确定rswag它被正确地钩住了。我看到的请求没有参数,我可以删除data参数并且没有任何变化。我已经尝试了一百万种组合,总是相同的结果,我不知道发生了什么。

params控制器期望的是data[attributes][file].

谁能帮我?

0 投票
2 回答
777 浏览

ruby-on-rails - 如何在 RSWAG 请求参数中添加组件?

我有一些在几乎所有 API 调用中都会调用的通用参数,因此可以为这些参数创建组件并在 rswag api 请求中调用它们。

就像是schema '$ref' => '#/definitions/parameters'

谢谢!

0 投票
1 回答
2199 浏览

ruby-on-rails - rspec_api_documentation - 如何有多个示例

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

宝石:

用于测试的 rspec_api_documentation 配置:

OpenAPI 配置:

示例测试:

生成的输出:

在此处输入图像描述 期望的输出(至少我认为):

在此处输入图像描述

0 投票
1 回答
879 浏览

ruby-on-rails - 如何在 RSpec 测试中在 RSwag 模式之外发送参数?

parameter使用 Ruby on Rails 中的 RSwag 和 RSpec,是否可以通过?发送未定义为 a 的参数run_test!

示例测试:

我想把sort[direction]我的context. 到目前为止我已经尝试过:

无济于事 - 我得到了 HTTP 200 成功,即使通过 Postman 发送的具有sort[direction]定义的相同请求以预期的 HTTP 422 Unprocessable Entity 响应。

0 投票
1 回答
2086 浏览

ruby-on-rails - Rails Rswag Swagger UI 未正确发送标头

我正在使用 gem rswag 作为 Rails API 的文档。我的 rails API 要求所有请求都包括headers['Content-Type']='my-fancy-content-type'headers['Accept']='my-fancy-accept. 到目前为止,我已经使用 POSTMAN 进行了测试,一切正常。我的 Rspec 测试也都通过了。

http://localhost:3002/api-docs/index.html. 我输入了正确的参数(在这种情况下只是 id)和正确的标题,如屏幕截图所示:

大摇大摆的用户界面

似乎没有发送任何标题。控制台显示它curl -X GET "http://localhost:3002/segments/122" -H "accept: */*"没有任何标题。

我设置了我的spec/swagger_helper.rb喜欢:

我的 swagger.yaml 看起来像:

用于生成 swagger 文档的测试片段是(它正常通过):

我尝试c.swagger_headers = { 'Content-Type' => 'my-fancy-content-type', 'Accept' => 'my-fancy-accept' }在里面添加 Rswag::Api.configconfig/initializers/rswag_api.rb但它不起作用(即不发送任何标题)。

在此先感谢您的帮助!