问题标签 [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 回答
247 浏览

ruby-on-rails - Rswag 嵌套属性语法

我有一个项目,我必须在 rswag 中编写嵌套属性

我正在尝试用 rswag 中的嵌套属性语法编写这个 json 正文:我试过这个:

0 投票
1 回答
430 浏览

ruby-on-rails - RSpec 和 rswag:如何在测试中执行排队作业

我在 Rails 5 中有一个 API 项目,使用 rswag 进行端点定义和测试。

一个控制器操作,create使用关键字参数将 ActiveJob 排入队列perform_later(job_title: @job, date: @date)

当我run_test!在我的请求规范中使用此操作时,我想立即运行排队的作业。

如何强制作业使用控制器操作中传递的关键字参数运行?

0 投票
1 回答
399 浏览

ruby-on-rails - rswag - 添加服务器的最佳实践

我目前正在尝试将服务器 URL 动态添加到我的招摇文档中。我有以下代码:

为了确保为每个 heroku 环境生成 swagger,我在我的 Procfile 中添加了一个发布命令:

我仍然在 API 文档的 heroku 实例中将 defaultHost 作为 localhost:3000 。

在此处输入图像描述

0 投票
1 回答
2119 浏览

ruby-on-rails - 如何设置不记名令牌参数以使用 Rswag UI 测试 Rails API

使用 Rswag UI gem 测试我的 API 时遇到问题。在参数字段中输入令牌后,似乎未在 UI 中正确设置授权标头。尽管如此,当我在终端中运行测试时,测试本身正在通过并且端点被击中。请查看下面附加的图片以获取更多信息。

我的身份验证方法application_controller如下所示:

swagger_helper安全定义如下所示

正在通过的测试如下所示:

这是我正在努力解决的问题:parameter name: :Authorization, in: :header, type: :string我尝试了不同的类型,例如 ,httpstringapiKey没有运气

Swager UI 应返回的 Curl 应如下所示:

在此处输入图像描述

0 投票
1 回答
150 浏览

ruby-on-rails - Swagger 嵌套参数对象

我想做一个招摇的端点,即请求主体是一个具有 2 个整数字段的产品对象和一个具有另外 2 个字段的选项对象,我将rswag其用作 ruby​​ gem

在我的规范中

但是,在我的用户界面中,我没有颜色或大小字段,只有一个选项文本字段,我该如何解决这个问题?

0 投票
1 回答
1087 浏览

rspec - Rspec swagger(openapi 3) 错误:“/components/responses”在架构上不存在

使用 gem rswag-specs (2.3.1)。根据https://swagger.io/docs/specification/components/定义:responses_components

测试失败并出现错误:

如何使用 /components/responses 部分?

0 投票
1 回答
202 浏览

ruby-on-rails - 如何使用 rspec 禁用 rswag 文件的测试,但仅将它们用于文档?

我在运行时遇到了 rswagspec/integration/*_spec.rb文件的问题,女巫进入了主线程rspec。在我的项目中,我只使用 rswag lib 来创建文档而不是测试。结果:rspec- 运行除 rswag 之外的所有测试。并且rake rswagspec/integration/*为文档运行。

0 投票
0 回答
107 浏览

ruby-on-rails - 如何在 Rswag 2.3.2 规范测试中分配全局变量?

我是 RoR 的新手,一个真正的新手。但是我有一个需要 RoR 进行后端开发的项目。在这个 API 文档的项目中使用的是Rswag. 当我尝试使用 授权端点时我碰壁了JWT,我想在全局上创建用户和 JWT 令牌,类似于Rspec可以做的事情。

但是在尝试将全局变量分配给rswag测试时遇到了问题,我已经尝试过使用before(:each),let()以及let!(),但它们仍然无法正常工作Rspec

这是我尝试使用let()或时遇到的错误let!()

在此处输入图像描述

如果我尝试使用Before Block,它不会返回任何错误,但是当我byebugbefore block.

目前这里是安装的版本列表:

这是我在问题中找到的最接近的答案,但这并不能解决我现在面临的问题

https://github.com/rswag/rswag/issues/168#issuecomment-454797784

感谢您提供任何帮助,谢谢:微笑:

0 投票
2 回答
619 浏览

ruby-on-rails - Rspec 使用 Request 和 rswag 测试 sign_in (Devise) 的问题

我很想将 rswag 与 rspec 一起使用来记录 REST API 并同时编写测试。我正在尝试使用教程和文档,但我无法让 sign_in 端点正常工作(设计 - 会话)。

当我运行 rspec 时,我收到状态代码错误。

比我有 RSpec 错误:

身份验证:JWT-token 内容类型:application/json 堆栈/Gems:

0 投票
1 回答
1763 浏览

ruby-on-rails - 在 Rails 中使用 rswag - 索引响应(数组)的语法是什么?

不幸的是,rswag 的“文档”似乎非常缺乏,并且没有给出如何实现索引操作的示例。我的“创建”规范在 Swagger UI 中显示架构和示例值,但我的“索引”方法没有在 UI 中显示其中任何一个。

我需要在这里改变什么?我已经根据我发现的有限示例来玩弄它,但它们似乎都不起作用。

我也尝试过像这样格式化架构,基于我发现的另一个示例,它也没有做任何事情(架构/示例只是没有显示): -