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

Question

目标： 我正在设计一个 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-键、request.term 和 request.rows。这是因为它从服务器获取的 JSON 将对象名称作为这些值的前缀。因此，当您尝试使用 Swagger UI 执行 HTTP GET 请求时，它会像

一样构建 URL

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

这是对服务器的错误请求。现在我可以轻松地让我的模型活页夹更智能，只忽略 "request." 部分，但这似乎是解决此问题的落后方法。

问题：如何在服务器端自定义由 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();
            }
        }
    }
}

Answer 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)

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

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

Alter parameter name for Swagger JSON generated through Swashbuckle in .NET Web API 2

c#

json

asp.net-web-api

swagger

swashbuckle