.NET Core Web API对接MongoDB CRUD时主键_id生成异常问题

你在Student实体上加的[BsonId]、[BsonRepresentation(BsonType.ObjectId)]是MongoDB C#驱动专属的序列化配置特性，仅用于告诉驱动如何完成实体类和Mongo BSON文档之间的转换：将该属性映射为文档的_id主键，存储时自动转换为ObjectId类型。
这两个特性完全不影响ASP.NET Core的模型绑定逻辑和Swagger的Schema生成规则。Swagger会默认扫描入参类型的所有公共可读可写属性生成入参表，只要id属性存在public setter，就会被识别为可传入字段，在调试页展示输入框。
问题对应的Swagger界面表现如下：

你可以根据项目实际情况选择以下任意一种方案解决：

方案1：拆分接口入参DTO（推荐，生产环境标准实践） #

不要直接将数据库实体类作为接口入参类型，单独定义接口层的请求传输对象（DTO），从根源上隔离数据库模型和对外接口契约：

// 创建学生接口的入参DTO，不包含主键id字段
public class CreateStudentDto
{
    public string name { get; set; }
    public int grade { get; set; }
}

接口中接收该DTO，手动映射为Student实体后插入MongoDB：

[HttpPost]
public async Task<IActionResult> AddStudent([FromBody] CreateStudentDto dto)
{
    var student = new Student
    {
        id = ObjectId.GenerateNewId().ToString(),
        name = dto.name,
        grade = dto.grade
    };
    await _studentCollection.InsertOneAsync(student);
    return Ok(student);
}

这种方式后续修改数据库字段不会影响对外接口的参数规则，可维护性最高。

方案2：给id属性加忽略特性（快速修复，适合小项目） #

如果不想额外定义DTO，可以直接给id属性添加ASP.NET Core内置的忽略特性，让模型绑定和Swagger跳过该字段：

using MongoDB.Bson;
using MongoDB.Bson.Serialization.Attributes;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using System.Text.Json.Serialization;

namespace Entities
{
    public class Student
    {
        [BsonId]
        [BsonRepresentation(BsonType.ObjectId)]
        [JsonIgnore] // 系统JSON序列化/反序列化时忽略该字段
        [BindNever] // 模型绑定时不从请求中读取该字段的值
        public string id { get; set; }

        public string name { get; set; }
        public int grade { get; set; }
    }
}

同时在项目启动配置中注册MongoDB的主键生成规则，避免插入数据时主键为空报错：

// Program.cs中添加
BsonClassMap.RegisterClassMap<Student>(map =>
{
    map.AutoMap();
    map.MapIdMember(s => s.id).SetIdGenerator(StringObjectIdGenerator.Instance);
});

配置完成后Swagger将不再展示id字段的输入框，插入数据时驱动会自动生成ObjectId作为主键。

方案3：自定义Swagger过滤器（多实体场景适用） #

如果项目中有大量Mongo实体需要统一处理，可以编写Swagger全局Schema过滤器，自动识别标记了[BsonId]的属性，将其从入参Schema中移除，无需逐个属性加忽略特性：

using Microsoft.OpenApi.Models;
using MongoDB.Bson.Serialization.Attributes;
using Swashbuckle.AspNetCore.SwaggerGen;

public class BsonIdSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        var bsonIdProperties = context.Type.GetProperties()
            .Where(prop => prop.GetCustomAttribute<BsonIdAttribute>() != null)
            .Select(prop => char.ToLower(prop.Name[0]) + prop.Name.Substring(1))
            .ToList();
        foreach (var propName in bsonIdProperties)
        {
            schema.Properties.Remove(propName);
        }
    }
}

在Program.cs的Swagger配置中注册该过滤器即可生效：

builder.Services.AddSwaggerGen(opt =>
{
    opt.SchemaFilter<BsonIdSchemaFilter>();
    // 其余原有Swagger配置
});

内容的提问来源于stack exchange，提问作者petra