ABP.NET Core迁移API至ApplicationCommon后Swagger不显示接口问题

可能原因 #

• 模块依赖未配置：Web项目的模块未正确依赖ApplicationCommon模块，导致ABP无法扫描到该项目中的ApplicationService，进而无法生成对应的API接口。
• Swagger未包含目标项目的API元数据：Swagger生成器默认可能只加载启动项目和部分引用项目的API信息，未包含ApplicationCommon项目的相关配置（如XML注释、API发现规则）。
• 迁移后的服务类不符合ABP自动API生成规则：比如服务类未继承ApplicationService、访问修饰符不是public，或者缺少必要的路由配置（ABP默认自动生成路由，但特殊场景可能需要手动调整）。

解决步骤 #

1. 确认模块依赖配置正确 #

• 在ApplicationCommon项目中，确保存在继承AbpModule的模块类（如ApplicationCommonModule），示例代码：

[DependsOn(typeof(AbpApplicationModule))]
public class ApplicationCommonModule : AbpModule
{
    // 模块初始化逻辑（按需添加）
}

• 在Web项目的模块类（如WebModule）的[DependsOn]特性中添加对ApplicationCommonModule的依赖：

[DependsOn(
    typeof(AbpAspNetCoreMvcModule),
    typeof(ApplicationCommonModule), // 添加该行依赖
    // 其他已有依赖模块
)]
public class WebModule : AbpModule
{
    // ...
}

2. 配置Swagger扫描目标项目API #

在Web项目的Swagger配置代码（通常在Program.cs）中，确保Swagger生成器包含ApplicationCommon项目的API元数据：

• 若启用了XML注释，添加该项目的XML文件路径：

builder.Services.AddSwaggerGen(options =>
{
    // 添加Web项目自身的XML注释
    var webXmlPath = Path.Combine(AppContext.BaseDirectory, "YourWebProject.xml");
    options.IncludeXmlComments(webXmlPath);
    
    // 添加ApplicationCommon项目的XML注释
    var commonXmlPath = Path.Combine(AppContext.BaseDirectory, "ApplicationCommon.xml");
    if (File.Exists(commonXmlPath))
    {
        options.IncludeXmlComments(commonXmlPath);
    }
    
    // 其他Swagger配置项
});

• ABP默认会扫描依赖模块下的所有ApplicationService，只要模块依赖配置正确，无需额外扫描规则；若有自定义过滤规则，需调整规则包含目标项目的命名空间。

3. 检查迁移后的服务类规范 #

• 确认迁移后的服务类（如AccountAppService、ConfigurationAppService等）继承自ApplicationService且访问修饰符为public：

public class AccountAppService : ApplicationService, IAccountAppService
{
    // 服务方法实现
}

• 若需手动指定路由，可在服务类上添加[RemoteService]和[Route]特性（ABP默认自动生成路由，此步为可选）：

[RemoteService]
[Route("api/account")]
public class AccountAppService : ApplicationService, IAccountAppService
{
    // ...
}

4. 清理并重新生成解决方案 #

右键解决方案选择「清理」，再重新生成所有项目，确保无编译错误后重启Web应用，查看Swagger是否显示目标接口。

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