Azure API管理加载App Service中.NET Core5 WebApi遇定义与关联问题

问题概述 #

• 直接通过App Service加载API时，仅显示各HTTP动词的通用方法，具体接口方法定义未加载
• 通过OpenAPI Definition加载API，虽能获取接口定义，但Postman请求App Service的外部流量未出现在APIM监控中，未关联到真实服务

已在Startup.cs中配置Swagger，但问题未解决：

var swaggerOptions = new SwaggerOptions();
Configuration.GetSection(nameof(SwaggerOptions)).Bind(swaggerOptions);

app.UseSwagger(option =>
{
    option.RouteTemplate = swaggerOptions.JsonRoute;
    option.SerializeAsV2 = true; // this is optional to control the swagger version
});

app.UseSwaggerUI(option =>
{
    option.SwaggerEndpoint(swaggerOptions.UIEndpoint, swaggerOptions.Description);
});

针对“直接加载App Service未显示接口方法”的解决步骤 #

1. 验证Swagger定义的可访问性

   • 在浏览器中访问https://<你的App Service域名>/swagger/v1/swagger.json，确认能返回包含所有接口方法的完整JSON内容
   • 若无法访问，检查App Service的防火墙规则、路由配置，确保Swagger路由未被拦截

2. 完善Swagger生成配置

   • 添加API文档生成逻辑（若未配置），确保接口方法被正确识别：

     services.AddSwaggerGen(c =>
     {
         c.SwaggerDoc("v1", new OpenApiInfo { Title = "你的API名称", Version = "v1" });
         // 启用XML注释（需在项目属性中开启XML文档文件生成）
         var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
         var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
         c.IncludeXmlComments(xmlPath);
     });
     

   • 确认SwaggerOptions中的JsonRoute配置正确，例如设置为swagger/{documentName}/swagger.json

3. 重新在APIM中导入App Service API

   • 删除APIM中已创建的错误API实例
   • 重新选择“从App Service创建API”，勾选**“导入Swagger/OpenAPI定义”**，并指定正确的Swagger JSON路径（如/swagger/v1/swagger.json）
   • 完成创建后，检查API设计页面，确认接口方法已加载

针对“OpenAPI导入后未关联真实服务”的解决步骤 #

1. 修正Swagger定义的服务器配置

   • 检查Swagger JSON中的servers节点，确保指向App Service的真实域名，若缺失则在Swagger配置中添加：

     app.UseSwagger(option =>
     {
         option.RouteTemplate = swaggerOptions.JsonRoute;
         option.SerializeAsV2 = true;
         // 自动注入当前App Service域名到Swagger定义
         option.PreSerializeFilters.Add((swaggerDoc, httpReq) =>
         {
             swaggerDoc.Servers = new List<OpenApiServer> { new OpenApiServer { Url = $"https://{httpReq.Host.Value}" } };
         });
     });
     

2. 检查APIM后端服务配置

   • 进入APIM中已导入API的“设计”页面，选择任意接口方法，查看“后端”配置
   • 确保后端服务指向你的App Service域名，而非占位符或错误地址
   • 若配置错误，手动添加后端：选择“后端”→“+ 添加后端”，选择“App Service”类型并关联目标服务，再将接口方法的后端指向该服务

3. 确保请求通过APIM转发

   • Postman测试时，必须使用APIM提供的API域名（如https://<你的APIM域名>/<API前缀>/<接口路径>），直接访问App Service的流量不会经过APIM，因此不会出现在监控中

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