ASP.NET Core OData导航属性异常：外键无效时返回NULL需求

I’ve run into this exact scenario working with ASP.NET Core Web API, OData, and Entity Framework Core—let’s break down the problem and walk through the fixes step by step.

Root Cause #

Your issue boils down to two conflicting configurations:

1. The EntityB.Value property uses the [Required] attribute, which OData translates into a non-nullable constraint in its EDM (Entity Data Model).
2. The EntityA.EntityB navigation property isn’t marked as nullable (for C# 8+ nullable reference types), so OData expects it to always reference a valid EntityB instance—even when the foreign key points to a non-existent record.

When you send the $expand=entityb($select=id,value) request, EF Core correctly sets EntityB to null (since no matching record exists), but OData’s serialization logic fails because it expects EntityB.Value to be present. This mismatch causes the corrupted JSON response you’re seeing.

Fixes to Implement #

1. Mark the Navigation Property as Nullable

First, update the EntityA class to explicitly declare the EntityB navigation property as nullable. This tells both EF Core and OData that this property can safely be null:

public class EntityA { 
    [Key] public int Id { get; set; } 
    public string Value { get; set; } 
    public int EntityBId { get; set; } 
    public EntityB? EntityB { get; set; } // Add nullable operator
}

2. Override the Required Constraint in the EDM Model

Since you can’t (or don’t want to) remove the [Required] attribute from EntityB.Value, you can override this constraint directly in the OData model builder. This lets OData ignore the database-level required constraint when serializing a null EntityB:

using Microsoft.OData.ModelBuilder;

public IEdmModel GetEdmModel()
{
    var builder = new ODataConventionModelBuilder();
    
    // Register your entity sets
    builder.EntitySet<EntityA>("EntityA");
    builder.EntitySet<EntityB>("EntityB");

    // Override the Required constraint for EntityB.Value
    builder.EntityType<EntityB>()
           .Property(b => b.Value)
           .IsRequired(false);

    return builder.GetEdmModel();
}

3. Confirm EF Core Loading Behavior

Make sure your OData controller loads the navigation property correctly. Using Include ensures EF Core will set EntityB to null when no matching record exists:

[EnableQuery]
public IQueryable<EntityA> Get()
{
    return _context.EntityA.Include(a => a.EntityB);
}

Why This Works #

By making the navigation property nullable and overriding the Required constraint in the EDM model, you give OData the flexibility to serialize a null value for EntityB when the foreign key doesn’t map to an existing record. This resolves the serialization conflict that was causing the corrupted JSON response.

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