基于Rswag，如何在Swagger UI中程序化设置表单字段值？

你可以通过Swagger UI提供的setRequestParameter方法规范设置参数值，完全不需要操作DOM。把逻辑放在onComplete回调里即可——这是UI加载完成后触发的官方钩子，很适合做初始化赋值操作。

具体实现方式 #

• 在onComplete回调中，通过Swagger UI实例调用setRequestParameter方法，指定参数的位置（比如你的场景是query类型参数）、参数名，以及要设置的值。
• 如果参数属于特定API接口，最好指定该接口的operationId，确保只给目标接口的表单赋值。

示例代码 #

configObject.onComplete = function(ui) {
  // 假设目标接口的operationId是"getFilteredData"
  // 设置date_range_start的值
  ui.setRequestParameter({
    operationId: "getFilteredData",
    name: "date_range_start",
    value: "服务端获取的起始日期",
    in: "query"
  });

  // 设置date_range_end的值
  ui.setRequestParameter({
    operationId: "getFilteredData",
    name: "date_range_end",
    value: "服务端获取的结束日期",
    in: "query"
  });
};

const ui = SwaggerUIBundle(configObject);

补充说明 #

如果你的OpenAPI规范里没定义operationId，也可以通过接口路径和HTTP方法定位：

ui.setRequestParameter({
  path: "/your/api/path",
  method: "get", // 对应接口的HTTP方法，比如post、put等
  name: "date_range_start",
  value: "起始日期值",
  in: "query"
});

这个方法是Swagger UI官方提供的，属于规范的程序化操作，完全避开了直接操作DOM的hack写法。

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