如何在Rswag中为指定API端点覆盖默认Server地址？

你遇到的问题是因为Rswag的默认DSL并没有直接提供servers方法来配置操作级别的OpenAPI服务器信息，不过咱们可以通过两种简单的方式解决这个问题：

方法1：用operation块直接配置 #

Rswag允许通过operation块直接操作OpenAPI的操作对象，在这里可以直接添加servers属性：

path('/v1/payment-methods/cards') do
  post('Create a payment method from card details') do
    tags('Payment Method')
    consumes('application/json')
    produces('application/json')
    # 你的其他请求参数、响应配置等内容...

    # 手动添加操作级别的servers配置
    operation do
      servers [{
        url: 'https://secure.tryedge.com',
        description: 'Edge secure card portal'
      }]
    end
  end
end

方法2：用extend_schema扩展操作Schema #

另一种方式是通过extend_schema方法，直接向操作的Schema中注入servers字段：

path('/v1/payment-methods/cards') do
  post('Create a payment method from card details') do
    tags('Payment Method')
    consumes('application/json')
    produces('application/json')
    # 你的其他请求参数、响应配置等内容...

    extend_schema do
      {
        servers: [
          {
            url: 'https://secure.tryedge.com',
            description: 'Edge secure card portal'
          }
        ]
      }
    end
  end
end

为什么原来的写法会报错？ #

Rswag的DSL优先封装了OpenAPI中更常用的字段（比如参数、响应、标签等），而操作级别的服务器配置属于相对小众的特性，所以没有默认提供对应的方法。上面两种方式都能绕过这个限制，手动添加你需要的OpenAPI配置。

使用任意一种方法后，生成的Swagger YML都会符合你的预期，在post节点下出现目标servers配置。

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