c# - 更改通过 .NET Web API 2 中的 Swashbuckle 生成的 Swagger JSON 的参数名称

Question

目标:我正在设计一个 REST API，允许用户在 HTTP GET 请求的查询字符串上传递参数。有点像

http://fake.api.com/search?api-key=1235&term=car&rows=10

实现:在服务器端，我有一个模型绑定(bind)器，它采用这 3 个参数 - api-key、term 和 rows，并将它们转换为 C# 对象，这样我的 Controller 操作方法就不会' 必须解析查询字符串。所以 Controller 操作方法签名看起来像

public IHttpActionResult Get(RequestObject request)

问题:我在使用 Swagger 时遇到的问题是，当它生成文档和测试工具时，它将输入参数列为 request.api-key、request.term 和 request。行。这是因为它从服务器获取的 JSON 将对象名称作为这些值的前缀。因此，当您尝试使用 Swagger UI 执行 HTTP GET 请求时，它会构建类似于

的 URL

http://fake.api.com/search?request.api-key=1235&request.term=car&request.rows=10

这是对服务器的错误请求。现在我可以轻松地让我的模型 Binder 变得更智能，从而忽略“请求”。部分，但这似乎是解决此问题的落后方法。

问题:如何在服务器端自定义由 Swashbuckle -> Swagger 生成的 JSON，以便此特定对象的参数名称不以对象名称为前缀？我确实研究了 Swashbuckle 可扩展性 API 公开的 ISchemaFilter 和 IDocumentFilter，但我没有看到一种干净的方法来执行此操作。也许有可能，但在这种情况下，一个例子会有所帮助。

Answer 1

找到了一个解决方案，结果是我忽略的一件事——IOperationFilter。参见 https://github.com/domaindrivendev/Swashbuckle/issues/128了解详情。

更新

这里是评论中提到的解决方案的代码

public class IgnorePrefixParamsNameBeforeDot : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        if (operation.parameters != null)
        {
            foreach (Parameter param in operation.parameters.Where(p => p.name.Contains('.')))
            {
                param.name = param.name.SplitWithoutEmpty('.').Last();
            }
        }
    }
}