如何使用 swashbuckle 在 swagger 的发布请求描述中隐藏属性？

Question

我是 ASP.NET Core 的新手，这个问题看起来很简单，但我在网上找不到合适的解决方案。所以问题就在这里。
这是我正在使用的类的结构。

public class Alert
{
    [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
    public string AlertId { get; set; }
    public string Type { get; set; }

}

这是swagger中Post请求API的描述。

{
  "alertId": "string",
  "type": "string"
}

由于我在发布请求中使用[DatabaseGenerated(DatabaseGeneratedOption.Identity)]注释是可选的。alertId我的目标是alertId仅隐藏帖子请求描述。
我正在使用 ASP.NET Core 3.1、EF Core(3.1.1) 和 Swashbuckle.AspDotNetCore(5.1.0)。
请帮忙。
谢谢。

Answer 1

您可以使用该Swashbuckle.AspNetCore.Annotations包，它允许您标记某些属性仅显示在输入参数中，某些属性仅显示在输出中。

在您的情况下，您想隐藏AlertId帖子的输入参数中的 ，您只需通过以下操作即可[SwaggerSchema]：

public class Alert
{
    [SwaggerSchema(ReadOnly = true)]
    public string AlertId { get; set; }
    public string Type { get; set; }
}

在文档中查看更多相关信息

在ConfigureServices的方法中Startup.cs，在 Swagger 配置块中启用注释：

services.AddSwaggerGen(c =>
{
   ...

   c.EnableAnnotations();
});