Azure Function App中Swagger/OpenAPI无法显示API的技术求助

针对你部署在Linux Premium计划、私有网络环境中且仅使用HTTPS的Azure Func应用遇到的Swagger UI无法正常显示的问题，结合你的配置和环境情况，我整理了几个实用的排查与修复方向：

1. 修正OpenApi__HostNames配置项 #

你当前设置的"OpenApi__HostNames": "/api"存在配置错误，这个参数需要填写的是函数应用的实际域名（比如yourappname.azurewebsites.net，如果用了自定义域名就填自定义域名），而非路由前缀。正确的配置示例如下：

{ "Values": { 
    "OpenApi__ForceHttps": "true", 
    "OpenApi__ForceHttp": "false", 
    "OpenApi__HostNames": "yourappname.azurewebsites.net" 
  } 
}

这个配置能让OpenApi扩展正确识别应用域名，生成符合HTTPS要求的Swagger文档路径。

2. 排查私有网络的访问规则 #

由于应用部署在私有网络内，需要确认以下网络配置：

• 你的客户端IP已添加到应用的访问限制允许列表，或者私有网络的NSG规则允许客户端访问函数应用的HTTPS端口（443）
• 如果使用了应用网关或防火墙，需确保Swagger相关路由（/api/swagger、/api/swagger/ui、/api/openapi/v3.json）没有被拦截

3. 升级OpenApi扩展版本 #

你当前使用的Microsoft.Azure.WebJobs.Extensions.OpenApi 1.0是较早的版本，早期版本对私有网络、HTTPS场景的支持存在已知兼容性问题。建议升级到最新的稳定版本（比如v1.5.x及以上），新版本修复了不少网络环境下的适配问题。

4. 先验证Swagger文档的基础访问 #

可以先跳过UI界面，直接访问Swagger的JSON文档地址：https://yourappname.azurewebsites.net/api/openapi/v3.json。如果这个地址能正常返回JSON内容，说明OpenApi扩展本身工作正常，问题大概率出在UI资源加载环节；如果返回404或报错，需要优先排查OpenApi扩展的配置与部署问题。

5. 确认HTTPS强制设置的一致性 #

确保函数应用已开启HTTPS Only设置（在Azure门户的应用服务配置→常规设置中），同时保持OpenApi__ForceHttps为true，避免协议规则冲突导致的加载异常。

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