Rswag未达预期效果？请求协助排查用户邀请系统API测试问题

从你给出的代码片段来看，我整理了几个可能导致Rswag表现不符合预期的常见原因和解决方法：

1. Body参数定义格式错误 #

你当前把invitation_token和password单独定义为body参数，但Rswag对于JSON类型的请求体，更推荐用schema对象来定义完整的请求结构。如果后端期望接收的是一个包含这两个字段的JSON对象，单独定义参数会导致Rswag生成的请求体格式不符合预期。

修改参数定义为：

parameter name: :invitation_params, in: :body, schema: {
  type: :object,
  required: [:invitation_token, :password],
  properties: {
    invitation_token: { type: :string, description: 'invitation token' },
    password: { type: :string, description: 'user password' }
  }
}

然后在测试块里对应这个参数：

let(:invited_user) { create(:user, :invited) } # 假设你用FactoryBot创建了处于邀请状态的用户
let(:invitation_params) do
  {
    invitation_token: invited_user.raw_invitation_token,
    password: 'SecurePassword123!'
  }
end

2. 未完整初始化测试数据 #

你的let(:invited_user)定义不完整，需要确保创建的用户处于已邀请状态（包含有效的邀请token）。如果用Devise Invitable，要确保用户的invitation_token和invited_at字段已正确设置：

# 示例FactoryBot工厂定义
FactoryBot.define do
  factory :user do
    # 基础字段...
    trait :invited do
      invitation_token { Devise.token_generator.generate(User, :invitation_token) }
      invited_at { Time.current }
    end
  end
end

3. 响应验证缺失 #

你的response块里没有添加测试断言或运行测试的逻辑，Rswag需要run_test!来执行测试并验证响应。补充完整响应块：

response '201', 'valid invitation token' do
  let(:invited_user) { create(:user, :invited) }
  let(:invitation_params) do
    {
      invitation_token: invited_user.raw_invitation_token,
      password: 'SecurePassword123!'
    }
  end

  # 可选：定义响应的JSON schema
  schema type: :object,
         properties: {
           id: { type: :integer },
           email: { type: :string },
           # 其他返回字段...
         }

  run_test! do |response|
    json = JSON.parse(response.body)
    expect(json['id']).to eq(invited_user.id)
    expect(json['email']).to eq(invited_user.email)
    # 验证用户已激活、邀请token已失效等业务逻辑
    invited_user.reload
    expect(invited_user.invitation_token).to be_nil
    expect(invited_user.confirmed_at).not_to be_nil
  end
end

4. 路由或控制器配置问题 #

确认你的API路由是否正确指向邀请更新接口。如果用Devise的话，路由可能需要这样配置：

# config/routes.rb
namespace :api do
  devise_for :users, controllers: { invitations: 'api/users/invitations' }
end

同时确保Api::Users::InvitationsController跳过了身份验证（因为邀请接口无需登录）：

class Api::Users::InvitationsController < Devise::InvitationsController
  skip_before_action :authenticate_user!, only: [:update]
  # 其他自定义逻辑...
end

如果这些调整后还是有问题，可以补充具体的错误信息（比如测试失败的日志、请求/响应的具体内容），这样能更精准地定位问题。

内容的提问来源于stack exchange，提问作者Eugene Yak