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

【问题标题】：Alter parameter name for Swagger JSON generated through Swashbuckle in .NET Web API 2更改通过 .NET Web API 2 中的 Swashbuckle 生成的 Swagger JSON 的参数名称
【发布时间】：2015-10-09 01:13:24
【问题描述】：

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

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

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

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

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

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

【问题讨论】：

标签： c# json asp.net-web-api swagger swashbuckle

【解决方案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();
            }
        }
    }
}

【讨论】：

你能指出所提供链接的哪一部分是感兴趣的吗？您是否必须自己实现逻辑（用“。”分割名称）还是您只需在 IOperationFilter 中调用的内置 swashbuckle？
我刚刚使用了 IOperationFilter，是的，我在 "." 上进行了拆分。手动，那里没有魔法。更优雅的方法是装饰该类上的每个属性并反射然后解析它们，但我时间紧迫，所以使用了不太优雅的解析解决方案。
SB 现在可以在没有此解决方法的情况下执行此操作吗？为IOperationFilter +1 甚至不知道有这样的事情哈哈。

【解决方案2】：

我遇到了类似的问题，并找到了一个简单的解决方案。

虽然在我的情况下是用于 POST/PUT，it won't work for GET since GET doesn't have a body。一旦我使用了 Attribute FromBody，Swagger 就开始渲染一个没有前缀的正确 JSON。所以就我而言，它看起来像这样：

public IHttpActionResult Post([FromBody]RequestObject request)

它没有直接回答你的问题，但我正在寻找一个非常相似的招摇相关问题的解决方案，这对我有帮助，所以我希望它对任何人都有帮助。

【讨论】：