更改中通过Swashbuckle生成的Swagger JSON的参数名。NETWebAPI 2

Question

目标：我正在设计一个RESTAPI，它允许用户在HTTP GET请求的查询字符串上传递参数。差不多

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

实现：在服务器端，我有一个模型绑定器，它接受这3个参数——api键、术语和行，并将它们转换为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

这是对服务器的不正确请求。现在我可以很容易地让我的模型活页夹更聪明，忽略“请求”一部分，但这似乎是解决这个问题的落后方法。

问题：我如何自定义由斯瓦什巴克生成的JSON-

Answer 1

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

虽然在我的例子中，它是用于POST/PUT的，但它对GET不起作用，因为GET没有主体。一旦我使用了属性FromBody，Swagger就开始呈现一个没有前缀的正确JSON。所以在我的例子中，它看起来是这样的：

public IHttpActionResult Post([FromBody]RequestObject request)

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

Answer 2

找到了一个解决方案，结果是我忽略了一件事——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();
            }
        }
    }
}