Microsoft.AspNetCore.OData服务文档生成相对@odata.context链接的方法
配置Microsoft.AspNetCore.OData生成相对@odata.context链接的方案
适用场景
反向代理部署后@odata.context链接前缀缺失的问题,可通过以下两种无需重写服务文档生成逻辑的方案解决:
方案1:直接输出相对路径(推荐)
8.x及以上版本Microsoft.AspNetCore.OData
在服务注册的AddOData配置段添加序列化配置即可:
builder.Services.AddControllers() .AddOData(opt => { // 原有配置:注册EdmModel、路由、查询能力等保持不变 opt.AddRouteComponents("your-odata-prefix", yourCustomEdmModel); opt.Select().Filter().OrderBy(); // 新增配置:强制生成相对路径的@odata.context opt.SerializerOptions.MetadataLinkFactory = (_, metadataSegment) => new Uri(metadataSegment, UriKind.Relative); });
7.x版本Microsoft.AspNetCore.OData
修改OData格式化器的消息写入配置:
public void ConfigureServices(IServiceCollection services) { services.AddControllers(opts => { var odataFormatters = opts.OutputFormatters.OfType<ODataOutputFormatter>(); foreach (var formatter in odataFormatters) { formatter.MessageWriterSettings.EnableRelativeUris = true; formatter.MessageWriterSettings.BaseUri = null; } }); }
方案2:适配反向代理保留绝对路径
如果不想用相对路径,也可以配置ASP.NET Core自带的ForwardedHeaders中间件,让服务拿到反向代理转发的原始请求信息,自动生成正确的绝对路径链接:
// 1. 服务注册段添加配置(放在最前面) builder.Services.Configure<ForwardedHeadersOptions>(opts => { opts.ForwardedHeaders = ForwardedHeaders.All; // 按需添加信任的反向代理IP,避免伪造头攻击 opts.KnownProxies.Add(IPAddress.Parse("192.168.1.100")); }); // 2. 中间件管道最开头注册(先于UseRouting、UseOData等中间件) var app = builder.Build(); app.UseForwardedHeaders(); // 其他中间件逻辑保持不变
两种方案均不需要修改默认服务文档生成逻辑,也不会影响你已经自定义实现的实体查询、函数调用接口逻辑。
内容的提问来源于stack exchange,提问作者kelko
相关产品推荐
相关产品推荐

