使用 swashbuckle 向 swagger 中的路径添加摘要或供应商扩展答案

【问题标题】：Add summary or vendorextensions to Paths in swagger using swashbuckle使用 swashbuckle 向 swagger 中的路径添加摘要或供应商扩展
【发布时间】：2019-12-26 10:23:44
【问题描述】：

根据openApi Spec

路径可能有一个可选的简短摘要和用于文档目的的较长描述。该信息应该与该路径中的所有操作相关。描述可以是多行的，并且支持 Markdown (CommonMark) 的富文本表示。

我正在使用swashbuckle 为我的 API 生成招摇的 UI 和文档。我需要为路径添加摘要和一些自定义字段。对于操作，我可以使用 IOperationFilter 添加但是我没有找到任何添加路径的方法。如何使用 Swashbuckle 添加？

【问题讨论】：

仅供参考，Swagger UI does not display 路径级摘要和描述。
是的，我知道，这很好。只是想要在文档中

标签： c# swagger swashbuckle

【解决方案1】：

无法在您要链接的版本中添加summary，请参阅型号PathItem：
https://github.com/domaindrivendev/Swashbuckle/blob/master/Swashbuckle.Core/Swagger/SwaggerDocument.cs#L75

public class PathItem
{
    [JsonProperty("$ref")]
    public string @ref;

    public Operation get;

    public Operation put;

    public Operation post;

    public Operation delete;

    public Operation options;

    public Operation head;

    public Operation patch;

    public IList<Parameter> parameters;

    public Dictionary<string, object> vendorExtensions = new Dictionary<string, object>();
}

如您所见，那里没有摘要...

我为您看到的唯一选择是分叉项目，然后将您需要的内容添加到该模型中，
我从 swagger-net 开始在同一条路上：
https://github.com/heldersepu/Swagger-Net
我需要的许多功能都丢失了，就像您建议的那样，如果您可以提供有关您要实现的目标的更多详细信息，我可以在 swagger-net 上添加该功能

【讨论】：

谢谢。我也意识到总结是不可能的。我也没有找到添加供应商扩展的简单方法。我采取了一种解决方法，我使用 IDocumentFilter 遍历所有路径并使用 vendorExtensions 添加自定义字段和值。