如何使用 Swagger UI 在方法描述上使用 html？

Question

我正在使用 Swashbuckle.AspNetCore 来可视化我的 .NET Core API 资源并与之交互。我正在尝试使用 html 格式化 Swagger 上的 API 方法描述，以便用户知道最近添加了此方法。

但我还没有找到如何做到这一点。我在摘要的 XML 文档注释中添加了 html 字符串，但以字符串形式返回。同时，我能够使其在响应中发挥作用。

我怎样才能让它发挥作用，或者使用一些“华丽”的方式来展示新方法，以便用户注意到它们是新的或更新的？这是我在控制器中的方法的代码。

    /// <summary>
    /// <span style="font-size: 20px;color: red;">☆New method!</span>
    /// </summary>
    /// <returns>Gets the user commerce data</returns>
    /// <response code="200"><div><span style="font-size: 20px;color: red;">Returns user commerce data</span></div></response>
    /// <response code="401">User not authenticated</response>       
    /// <response code="404">Error: Not Found</response>       

    [HttpGet]
    [SwaggerResponse(200, Type = typeof(CommerceUserProfile))]
    [ProducesResponseType(401, Type = typeof(UnauthorizedResult))]
    [ProducesResponseType(404, Type = typeof(NotFoundResult))]
    public async Task<ActionResult<CommerceUserProfile>> Get()

这是我的启动代码。

     services.AddSwaggerGen(swagger =>
                {
                    swagger.SwaggerDoc("v1", new Info { Title = "API", Version = "v1" });
                    var xmlPath = Path.Combine(AppContext.BaseDirectory, "CommerceWebAPI.xml");
                    swagger.IncludeXmlComments(xmlPath);
                }

这就是正在生成的内容。我想使用 html 格式化获取描述，就像我在响应中所做的那样。

Answer 1

Swagger 有意逃避摘要内容。

我认为这真的不可能实现你想要的。

也不支持Markdown才能使用总结。但 swagger 在其他一些场景下是支持的。