Rswag中处理多对象查询参数的实践指南

问题背景

在使用Rswag进行API文档生成和测试时，开发者经常会遇到需要传递多个对象作为查询参数的情况。例如，在一个搜索接口中，我们可能需要同时传递搜索条件(search)和分页信息(pagination)两个对象参数。

常见错误做法

许多开发者会尝试以下写法：

parameter name: :search, in: :query, schema: {
  type: :object,
  properties: {
    query: { type: :string, example: 'foo' },
    sort: { type: :string, example: 'created_at_desc' }
  }
}
parameter name: :pagination, in: :query, schema: {
  type: :object,
  properties: {
    page: { type: :integer, example: 1 },
    per: { type: :integer, example: 10 }
  }
}

这种写法虽然生成的YAML文档看起来正确，但在实际测试时会产生错误的查询字符串格式，如search?query=foo&sort=created_at_desc&page=1&per=10，这不符合Rails处理嵌套参数的惯例。

解决方案一：使用params包装器

最可靠的方式是将所有对象参数包装在一个顶层params对象中：

parameter name: :params, in: :query, schema: {
  type: :object,
  properties: {
    search: {
      type: :object,
      properties: {
        query: { type: :string, example: 'foo' },
        sort: { type: :string, example: 'created_at_desc' }
      }
    },
    pagination: {
      type: :object,
      properties: {
        page: { type: :integer, example: 1 },
        per: { type: :integer, example: 10 }
      }
    }
  }
}

对应的测试用例写法：

response 200, 'success' do
  let(:params) { { search: { query: 'foo', sort: 'created_at_desc' }, pagination: { page: 1, per: 10 } } }
  run_test!
end

这种方式会生成符合Rails惯例的查询字符串格式：?search[query]=foo&search[sort]=created_at_desc&pagination[page]=1&pagination[per]=10

解决方案二：使用deepObject样式

OpenAPI 3.0+支持通过style: :deepObject参数来指定嵌套对象的序列化方式：

parameter name: :search, in: :query, schema: {
  type: :object,
  properties: {
    query: { type: :string, example: 'foo' },
    sort: { type: :string, example: 'created_at_desc' }
  }
}, style: :deepObject

parameter name: :pagination, in: :query, schema: {
  type: :object,
  properties: {
    page: { type: :integer, example: 1 },
    per: { type: :integer, example: 10 }
  }
}, style: :deepObject

这种方式理论上应该生成类似?search[query]=foo&search[sort]=created_at_desc&pagination[page]=1&pagination[per]=10的查询字符串，但在某些Rswag版本中可能存在兼容性问题。

最佳实践建议

1. 优先使用params包装器方案：这是最稳定可靠的方式，兼容性最好，生成的文档结构也清晰。

2. 注意参数命名一致性：确保测试用例中的参数名(:params)与文档定义中的参数名一致。

3. 考虑API使用者体验：无论选择哪种方式，都应确保生成的API文档清晰易读，参数结构一目了然。

4. 版本兼容性检查：如果使用deepObject样式，需要确认使用的Rswag版本是否完全支持OpenAPI 3.0规范。

总结

在Rswag中处理多对象查询参数时，开发者需要特别注意参数的嵌套结构和序列化方式。通过合理使用params包装器或deepObject样式，可以确保生成的API文档和实际请求格式符合预期。在实际项目中，建议根据团队的技术栈和API设计规范选择最适合的方案。