.NET Core 6如何避免依赖项目baseApi的端点在myOtherApi中暴露

问题根源 #

myOtherApi直接引用baseApi项目时，会继承baseApi中注册的所有端点路由配置，导致原本仅面向管理员的baseApi端点在myOtherApi中对外暴露。

解决方案 #

1. 拆分共享模型到独立类库（推荐方案） #

这是最彻底的解耦方式，从根源避免依赖项目的逻辑侵入：

• 新建一个.NET类库项目（例如BaseApi.SharedModels），将baseApi中需要共享的模型类迁移到这个类库中。
• 修改baseApi项目，引用这个类库并使用其中的模型。
• 修改myOtherApi项目，移除对baseApi项目的直接引用，改为引用BaseApi.SharedModels类库。
• 这样myOtherApi仅依赖模型类，不会加载baseApi的端点注册逻辑。

2. 通过环境判断控制baseApi端点注册（临时兼容方案） #

如果暂时无法拆分项目，可以在baseApi的启动逻辑中添加判断，仅当自身运行时才注册专属端点：

var builder = WebApplication.CreateBuilder(args);

// 注册服务...

var app = builder.Build();

// 仅当当前应用是baseApi时，注册管理员专属端点
if (builder.Environment.ApplicationName.Equals("baseApi", StringComparison.OrdinalIgnoreCase))
{
    app.MapGet("/groups/opened", () => Results.Ok("返回开放群组数据"));
    app.MapGet("/users/whitelist", () => Results.Ok("返回白名单用户数据"));
}

// 通用中间件配置（如授权、静态文件等）...

app.Run();

3. 用自定义特性过滤端点（适合已有大量端点的场景） #

通过标记baseApi的端点并在myOtherApi中过滤，阻止这些端点对外响应：

• 第一步：创建自定义特性标记管理员专属端点

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public class AdminExclusiveApiAttribute : Attribute { }

• 第二步：在baseApi的控制器或方法上添加该特性

[ApiController]
[Route("[controller]")]
[AdminExclusiveApi]
public class UsersController : ControllerBase
{
    [HttpGet("whitelist")]
    public IActionResult GetWhitelist() => Ok("白名单数据");
}

• 第三步：在myOtherApi的端点配置中过滤带有该特性的路由

var app = builder.Build();

app.MapControllers()
   .AddEndpointFilter(async (context, next) =>
   {
       var endpoint = context.HttpContext.GetEndpoint();
       if (endpoint?.Metadata.GetMetadata<AdminExclusiveApiAttribute>() != null)
       {
           // 返回403禁止访问，或404隐藏端点存在
           return Results.Forbid();
       }
       return await next(context);
   });

// 其他中间件配置...

app.Run();

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