时间戳

首页 > 解决方案 > Swagger UI 中的 XML 注释格式不佳

asp.net-core - Swagger UI 中的 XML 注释格式不佳

问题描述

我正在使用 Swashbuckle 设置 Swagger UI 并让它在我的操作中显示我的 XML 注释。

当我这样做时，它们最终看起来非常挤压。这是一个没有注释的示例：

看起来不错，但没有评论

以下是评论后的样子：

有注释但方法名称被压扁

有没有办法让 Swagger UI 为操作名称分配更多空间？

标签： asp.net-coreswagger-uiswashbuckleasp.net-core-3.1

解决方案

<summary>应该是一个简短的摘要，例如“Create a foo”或“Return a foo by ID”。包含使用细节的长描述应该去<remarks>。<remarks>对应 OpenAPIdescription字段；Swagger UI 在扩展操作中显示这些描述。这些描述可以使用 Markdown 格式化以进行富文本表示。

/// <summary>
/// Create a foo
/// </summary>
/// <remarks>
/// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
/// sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
/// Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris
/// nisi ut aliquip ex ea commodo consequat.
/// </remarks>

推荐阅读