Swashbuckle IDocumentFilter实现-如何将ActionDescriptor.MethodInfo链接到操作

Question

• 项目：ASP Net Core 2.2，Web API
• 软件包：Swashbuckle.AspNetCore（4.0.1）

我正在编写一个实现Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter，该实现在我的swagger配置文件中的路径级别添加x-summary值。为此，它需要访问每种Web方法的以下两条信息]

1. [ApiDescription.ActionDescriptor.MethodInfo-获取对方法属性的访问权限
2. Operation.Summary-方法的Xml注释

似乎我可以从提供给IDocumentFilter实现的context中获得＃1，并从swaggerDoc中获得＃2，但是除了使用路径之外，我找不到链接它们的好方法。

是否有更整洁的方法？

下面是我正在做的简化示例。

public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
{
  // Create a map from path (prepended with "/") to the custom attribute
  var methodsByPath = context.ApiDescriptions
    .ToDictionary(
      m => $"/{m.RelativePath}",
      m => ((ControllerActionDescriptor)m.ActionDescriptor).MethodInfo.GetCustomAttribute<MyCustomAttribute>());

  // Add x-summary to each path
  foreach (var pathItem in swaggerDoc.Paths)
  {
    var customAttribute = methodsByPath[pathItem.Key];

    pathItem.Value.Extensions["x-summary"]
      = GeneratePathDescription(pathItem.Value.Post.Summary, customAttribute);
  }
}

string GeneratePathDescription(string methodSummary, MyCustomAttribute attr)
{
  [snip]
}

Answer 1

您的实现对我来说看起来很整洁，但是如果您正在寻找如何“最佳”实现IDocumentFilter的示例，请在Swashbuckle的代码中查看：

https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/e2f30e04f412b821a5a989338a186e422c776cc4/src/Swashbuckle.AspNetCore.Annotations/AnnotationsDocumentFilter.cs

https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/b64b8fd6fbc7959849445be676f5e3d4a8e947bf/src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsDocumentFilter.cs