【问题标题】:XML Comments Format Poorly in Swagger UISwagger UI 中的 XML 注释格式不佳
【发布时间】:2020-02-26 17:22:09
【问题描述】:

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

当我这样做时,它们最终看起来非常挤压。下面是一个没有 cmets 的例子:

这是使用 cmets 的样子:

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

【问题讨论】:

  • Ye @Helen 对 remarks 的看法是正确的,但如果您想进行更多调整,您可以注入 CSS 以满足您的需求

标签: asp.net-core swagger-ui swashbuckle asp.net-core-3.1


【解决方案1】:

<summary> 应该是一个简短的摘要,例如“Create a foo”或“Return a foo by ID”。包含使用细节的长描述应该去<remarks><remarks> 对应 OpenAPI description 字段; 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>

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-12-26
    • 2019-10-26
    • 1970-01-01
    • 2020-04-04
    • 2016-01-27
    相关资源
    最近更新 更多