如何使用Faraday自定义Stub请求？解决RubyMine参数报错问题

问题根源 #

你代码里的语法错误导致RubyMine报错：req.body: {body: "body"} 是哈希字面量的写法，但在Faraday的请求块中，需要使用赋值语句来设置请求体和请求头，而非这种键值对语法。虽然测试能运行，但RubyMine的静态代码分析会识别为语法错误。

正确配置方式 #

1. 修正请求头与请求体的赋值语法 #

Faraday的请求对象（req）的headers是一个哈希对象，body是可赋值的属性，正确写法如下：

conn = Faraday.new(url: "url") do |faraday|
  faraday.response :raise_error
end

conn.get("url") do |req|
  # 设置请求体：注意GET请求通常不携带body，若需POST/PUT等方法才更合理
  req.body = { body: "body" }.to_json
  # 设置请求头：直接向headers哈希添加键值对，或整体赋值
  req.headers["Content-Type"] = "application/json"
  req.headers["X-Custom-Header"] = "headers"
  # 也可以整体赋值headers
  # req.headers = { "Content-Type" => "application/json", "X-Custom-Header" => "headers" }
end

2. 关于GET请求携带body的说明 #

HTTP规范中GET请求通常不建议携带请求体，部分服务器可能会忽略。如果是需要发送带body的请求，建议使用POST/PUT等方法：

conn.post("url") do |req|
  req.body = { body: "body" }.to_json
  req.headers["Content-Type"] = "application/json"
end

3. 自定义Stub的正确写法（针对测试场景） #

如果你是在测试中自定义Faraday Stub，完整的Stub配置示例如下（结合RSpec）：

# 配置Stub连接
stub_conn = Faraday.new do |faraday|
  faraday.adapter :test do |stub|
    stub.get("/target-url") do |env|
      # 验证请求头
      expect(env.request_headers["X-Custom-Header"]).to eq("headers")
      # 验证请求体（若有）
      expect(JSON.parse(env.body)).to eq({ "body" => "body" })
      # 返回模拟响应
      [200, { "Content-Type" => "application/json" }, { status: "ok" }.to_json]
    end
  end
end

# 使用Stub连接发送请求
stub_conn.get("/target-url") do |req|
  req.headers["X-Custom-Header"] = "headers"
  req.body = { body: "body" }.to_json
end

为什么你的代码测试能通过？ #

Ruby的语法容错性较高，req.body: {body: "body"} 会被解析为一个哈希字面量，但这个哈希并没有被实际使用，相当于在块里写了一个无用的表达式。而Faraday默认可能使用了空的body和默认headers，所以测试刚好通过，但这并不是正确的配置方式。

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