RSwag不支持请求中多API Key对的解决方案问询

方案1：重写单个测试文件的build_request方法 #

在具体的RSwag请求测试文件里，直接重写build_request方法，手动追加第二个API Key头：

def build_request(path, http_method, metadata)
  request = super
  # 替换为你的第二个API Key头键名和对应值
  request.add_header('Second-API-Key', ENV['SECOND_API_KEY'])
  request
end

这种方式会保留OpenAPI配置中读取的第一个API Key，同时手动添加第二个，完全不影响文档展示效果。

方案2：全局扩展RSwag的请求构建逻辑 #

如果需要所有RSwag测试都自动带上双认证头，可在spec/swagger_helper.rb里扩展RSwag的RequestBuilder类：

module Rswag
  module Specs
    class RequestBuilder
      alias_method :original_build_request, :build_request

      def build_request(path, http_method, metadata)
        request = original_build_request(path, http_method, metadata)
        # 按需设置第二个API Key的键名和值
        request.add_header('Second-API-Key', ENV['SECOND_API_KEY'])
        request
      end
    end
  end
end

全局配置后无需在每个测试文件重复编写代码，所有RSwag测试请求都会自动携带双认证头。

关键注意点 #

• 务必将代码中的Second-API-Key替换为你实际使用的请求头键名，值建议从环境变量或配置文件读取，避免硬编码敏感信息。
• 以上修改仅作用于测试请求阶段，不会改变OpenAPI文档的展示内容，文档仍会遵循你原本的YAML配置。

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