如何避免ServiceStack API Explorer中GET请求空输入的DTO绑定错误

方案1：修改API Explorer表单提交逻辑，移除无值参数 #

ServiceStack的API Explorer基于Swagger UI，可通过注入自定义脚本拦截表单提交，自动移除未填写值的参数：

在应用启动配置中添加自定义HTML脚本：

SetConfig(new HostConfig {
    HtmlIncludes = {
        "<script>document.addEventListener('DOMContentLoaded', function() { " +
        "const form = document.querySelector('#swagger-ui form'); " +
        "if (!form) return; " +
        "form.addEventListener('submit', e => { " +
        "form.querySelectorAll('input[name]').forEach(input => { " +
        "if (!input.value.trim()) input.remove(); " +
        "}); " +
        "}); " +
        "});</script>"
    }
});

这段脚本会在表单提交前删除所有空值输入控件，避免生成包含无值参数的查询字符串。

方案2：全局过滤无效QueryString参数 #

通过请求过滤器过滤掉QueryString中的null/空键，再用自定义绑定器处理DTO绑定：

1. 添加全局请求过滤器：

GlobalRequestFilters.Add((req, res, dto) => {
    var filteredQs = new NameValueCollection();
    foreach (string key in req.QueryString.Keys) {
        if (!string.IsNullOrEmpty(key)) {
            filteredQs.Add(key, req.QueryString[key]);
        }
    }
    req.Items["FilteredQueryString"] = filteredQs;
});

2. 自定义DTO绑定器：

public class PublicationGetBinder : IRequiresRequest, IBindFromRequest
{
    public IRequest Request { get; set; }

    public void BindToRequest(IRequest req, object dto)
    {
        if (req.Items.TryGetValue("FilteredQueryString", out var obj) && obj is NameValueCollection filteredQs) {
            req.Bind(dto, filteredQs);
        } else {
            req.Bind(dto);
        }
    }
}

3. 在DTO上绑定自定义绑定器：

[Route("/publication", "GET")]
[Binder(typeof(PublicationGetBinder))]
public class PublicationGet : IReturn<Publication>
{
    public bool? Include { get; set; }
    public int? Id { get; set; }
    public string Uid { get; set; }
}

方案3：调整DTO属性配置 #

如果无值参数对应DTO的非可空值类型（如bool而非bool?），ServiceStack绑定可能抛出异常。将相关属性改为可空类型，允许接收空值：

public class PublicationGet : IReturn<Publication>
{
    // 改为可空类型，适配无值参数场景
    public bool? Include { get; set; }
    public int? Id { get; set; }
    public string Uid { get; set; }
}

方案4：升级ServiceStack版本 #

该问题可能是特定版本的已知bug，升级到ServiceStack最新稳定版（如6.x后续版本），官方可能已修复API Explorer的表单提交逻辑问题。

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