SwaggerUI 中模型属性的注解

Question

我已经构建了一个 ASP.Net Core 3.1 Web API，我对为我的客户自动生成文档很感兴趣。我已按照此处找到的非常简单的说明进行操作：Microsoft docs 在我的项目中安装 NSwag 或 Swashbuckle，在这两种情况下我都可以看到我的 API 的文档，但没有关于模型的描述属性。

Java 似乎对此有一个 @ApiModelProperty 注释，但我在 .Net 中没有看到类似的属性。是否可以在这些 swagger 实现中的任何一个中添加模型属性的描述，这将显示在 Swagger UI?

的 Schema 部分

Answer 1

标准 xml 文档摘要适合我。

public class TokenRefreshRequest
{
    /// <summary>
    /// The JWT access token
    /// </summary>
    public string AccessToken { get; set; }

    /// <summary>
    /// The refresh token that was sent via the new token endpoint or the last refresh.
    /// </summary>
    public string RefreshToken { get; set; }
}

在 swagger 页面上显示为；

您也可以添加有限的降价，但我似乎找不到 link。

SwaggerUI 中模型属性的注解

Annotations on model properties in SwaggerUI

swagger

swashbuckle

nswag