如何为每个Swagger请求添加查询参数？

Question

我有一个使用. NET 6 Web API的应用程序。一旦用户登录到应用程序，关于该用户的基于小上下文的信息被附加到查询参数。

API中AuthPolicy的一部分是，当调用endpoint时，这些查询参数必须存在，即使该endpoint没有使用它们。

例如，此 SaveClient 终结点具有在请求正文中传递的实际输入，但 AuthPolicy 要求查询参数存在，即使未使用它也是如此。

有效EX:SaveClient？客户端Id=1

无效的EX: SaveClient

有没有办法让Swagger将查询参数硬编码到它的请求URL？

Answer 1

我发现可以扩展< code>IOperationFilter,它的< code>Apply方法可以向每个endpoint添加参数。

public class ClientFilter : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context) 
    {
        if (operation.Parameters is null)
        {
             operation.Parameters = new List<OpenApiParameter>();
        }

        if (!operation.Parameters.Any(x => x.Name.Equals("clientId", StringComparison.OrdinalIgnoreCase)))
        {
             operation.Parameters.Add(new OpenApiParameter()
             {
                 Name = "clientId"
                 In = ParameterLocation.Query,
                 Description = "ClientId Parameter",
                 Required = true,
             };
        }
    }
}

从这里，您可以在Startup.cs中添加此OperationFilter：

services.AddSwaggerGen(c =>
{
    c.OperationFilter<ClientFilter>();
}