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

Question

How can I ask Swagger not to ask id for POST method (creation of entity in DB)?

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

There is an auto-incrementation in my SQL Server, so I think on frontend it's not necessary to input Id and there will be no field for Id. But is it possible to ask swagger not to show id?

Answer 1

Create a dedicated create dto:

public class CreateDto {

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

and in your controller create an instance of your db entity from the incoming CreateDto object.

Answer 2

You could try with JsonIgnore attribute if you don't need to Serialize the model somewhere else in your project I tried as below:

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

The result:

Answer 3

There is a better way now with now. There are two things you need to do

1. Annotate with SwaggerSchema found in Swashbuckle.AspNetCore.Annotations;

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

2. EnableAnnotations in AddSwaggerGen

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

See more about it in the Documentation