如何在Rails控制台直接调用带参数的Grape API

Grape本质是Rack应用，你可以在Rails控制台里通过构造Rack请求环境直接调用API，以下是不同场景下的参数传递方法：

1. 基础调用方式（通用所有请求类型） #

利用Rack::MockRequest.env_for构造请求环境，再调用API类的call方法即可。

GET请求（传递查询参数） #

假设你的API路径是/api/v1/users，需要传递分页参数：

# 构造GET请求环境
env = Rack::MockRequest.env_for(
  "/api/v1/users",
  method: "GET",
  params: { page: 1, per_page: 10 } # URL查询参数
)

# 执行API调用
response = MyApp::API.call(env)

# 解析响应结果（Grape响应格式为 [状态码, 响应头, 响应体]）
JSON.parse(response[2].body)

POST请求（表单参数） #

如果API接收表单格式的参数：

env = Rack::MockRequest.env_for(
  "/api/v1/users",
  method: "POST",
  params: { user: { name: "张三", email: "zhangsan@example.com" } },
  "CONTENT_TYPE" => "application/x-www-form-urlencoded"
)

response = MyApp::API.call(env)
JSON.parse(response[2].body)

POST请求（JSON参数） #

如果API要求JSON格式的请求体：

# 构造JSON请求体
request_body = { user: { name: "张三", email: "zhangsan@example.com" } }.to_json

env = Rack::MockRequest.env_for(
  "/api/v1/users",
  method: "POST",
  input: request_body,
  "CONTENT_TYPE" => "application/json"
)

response = MyApp::API.call(env)
JSON.parse(response[2].body)

2. 传递认证/自定义请求头 #

如果你的API需要认证（比如Bearer Token），可以在请求环境里添加对应的HTTP头：

env = Rack::MockRequest.env_for(
  "/api/v1/users/1",
  method: "PUT",
  params: { user: { name: "李四" } },
  "HTTP_AUTHORIZATION" => "Bearer your_authentication_token",
  "X-Custom-Header" => "custom_value" # 自定义头同理
)

response = MyApp::API.call(env)

3. 注意事项 #

• 确保你的API类（比如MyApp::API）已在Rails控制台中加载，若API定义在单独文件或引擎中，可能需要手动require 'path/to/your/api'
• 响应体可能是数组形式（比如Rack::BodyProxy），如果解析失败可以尝试response[2].join后再解析
• 路径要和API挂载的路由一致，比如在config/routes.rb中mount MyApp::API => '/api'，则请求路径要以/api开头

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