如何在 Create 方法上设置 Swagger 忽略 id 属性？ C# ASP.NET 内核 Swagger

Question

我怎样才能要求 Swagger 不询问 POST 方法的 id（在 DB 中创建实体）？

{
  "id": 0,
  "name": "string",
  "quantity": 0,
  "typeId": 0,
  "brandId": 0
}

我的 SQL 服务器中有一个自动增量，所以我认为在前端不需要输入 Id 并且不会有 Id 字段。 但是是否可以要求 swagger 不显示 id？

Answer 1

创建一个专用的create dto：

public class CreateDto {

  public class Name { get; set;}
  public int Quantity { get; set;}
  ...
}

并在您的控制器中从传入的CreateDto对象创建您的 db 实体的实例。

Answer 2

如果您不需要在项目中的其他地方序列化模型，您可以尝试使用 JsonIgnore 属性，我尝试如下：

public class TestModel
    {
        public int Id { get; set; }
        public string Name { get; set; }
        [JsonIgnore]
        public string Hide { get; set; }
    }

结果：

Answer 3

现在有一个更好的方法。 你需要做两件事

1. 使用 Swashbuckle.AspNetCore.Annotations 中的 SwaggerSchema 进行注释；

    [SwaggerSchema(ReadOnly = true)]
    public int Id { get; set; }

2. AddSwaggerGen 中的 EnableAnnotations

    builder.Services.AddSwaggerGen(options =>
    {
        options.EnableAnnotations();
    });

在文档中查看更多信息