ASP。Net Web API Swashbuckle如何忽略HttpRequestMessage

Question

我正在使用Swashbuckle为API生成文档。我的控制器方法如下：

[ResponseType(typeof(CategoryCollectionModel))]
        public HttpResponseMessage Get(HttpRequestMessage request, [FromUri]Paging paging)
        {
            var input = new CategoriesListQuery.Input { Page = paging.Page, Size = paging.Size };
            var result = this.queryInvoker.Execute<CategoriesListQuery.Input, CategoriesListQuery.Result>(input);
            var items = Mapper.Map<CategoryCollectionModel>(result);

            return request.CreateResponse(HttpStatusCode.OK, items);
        }

Swashbuckle将< code>HttpRequestMessage视为生成的文档中的一个参数。有没有办法配置Swashbuckle忽略< code>HttpRequestMessage，因为它只是出于测试目的才包含在签名中？

Answer 1

我从“http://www . morganskinner . com/2016/02/ignitioning-parameters-in-swash buckle . html”中找到了解决方法

总结：

在Swashbarle中，您可以插入操作“过滤器”，用于更改发出的数据——过滤器将传递发出的操作的上下文，您可以对弹出的数据进行修改。然后我所要做的就是创建一个过滤器来查找此数据类型，并从结果中删除相应的数据。我最终得到了这个…

     public class IgnoreHttpRequestMessageOperationFilter : IOperationFilter
  {
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, 
                      ApiDescription apiDescription)
    {
      apiDescription.ParameterDescriptions
        .Where(desc => desc.ParameterDescriptor.ParameterType 
            == typeof(HttpRequestMessage))
        .ToList()
        .ForEach(param =>
        {
          var toRemove = operation.parameters
            .SingleOrDefault(p => p.name == param.Name);

          if (null != toRemove)
            operation.parameters.Remove(toRemove);
        });
    }
  }

有了这个类，我只需要将其插入swagger配置文件中，如下所示。。。

c.OperationFilter<IgnoreHttpRequestMessageOperationFilter>();

为我工作。谢谢“摩根”

Answer 2

请参考这里的讨论。简而言之，不要像在输入参数中那样传入< code>HttpRequestMessage，而是模仿< code>{controller}。请求属性。