You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何配置APIM自动使用Azure Function生成的Swagger文档?

如何让Azure API Management自动使用Azure Function的OpenAPI文档,避免手动导入?

可以实现,不需要每次Function的OpenAPI定义变更都手动编辑或导入,主要有两种配置方式:

方法一:导入时启用自动同步

当你从Azure Function向APIM导入API时,选择**"函数应用"**作为API类型,而非手动上传OpenAPI文件:

  • 在导入配置界面,找到**"自动同步"**选项并开启,APIM会定期检测Function的OpenAPI定义变化,自动同步端点和文档内容
  • 同步频率可在APIM的API设置中调整,默认每日同步一次,也可根据需求设置更短的间隔

方法二:修改现有API的定义来源

如果已经完成API导入,可直接修改API的定义来源指向Function的OpenAPI端点:

  1. 进入APIM的目标API配置页,找到"定义"选项卡
  2. 将定义来源从"文件"切换为**"URL"**
  3. 填入Function的OpenAPI文档地址,例如https://<你的函数应用名>.azurewebsites.net/openapi/v3.json
  4. 若Function的Swagger端点需要身份验证,在配置中添加对应的认证信息(如API密钥)
  5. 保存后,APIM会直接从该URL拉取最新定义,也可手动点击"刷新"触发同步;如需自动定期刷新,可通过APIM的REST API或Azure CLI配置定时任务

注意事项

  • 确保APIM可以访问Function的OpenAPI端点:如果Function设置了IP限制,需将APIM的出站IP地址加入允许列表
  • APIM的开发者门户会自动基于拉取到的OpenAPI定义生成并更新API文档,无需手动维护

内容的提问来源于stack exchange,提问作者user23247925

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.01 16:00:58