如何避免在WSO2 API-M部署新API后重启服务器

1. 规范API发布流程 #

• 必须通过API Publisher控制台完成完整流程：创建API → 保存配置 → 发布到网关。正常情况下，点击「发布到网关」后，网关会自动触发热部署，无需重启服务。
• 若使用API归档包（.zip）部署，需在Carbon控制台上传后点击部署到网关按钮，不要手动将文件复制到<APIM_HOME>/repository/deployment/server/synapse-configs/default/api目录——手动复制可能无法触发自动扫描，导致需要重启。

2. 启用自动部署配置 #

打开<APIM_HOME>/repository/conf/deployment.toml，确认以下配置已开启（默认应为true，若被修改需改回）：

[apim.gateway.deployment]
auto_update = true

该配置控制网关是否自动检测API配置变化并热部署，修改后无需重启，配置会动态生效。

3. 集群环境下的API同步配置 #

如果是多节点集群部署：

• 确保所有网关节点已配置与API Publisher/Store的正确连接，保证API发布后能自动同步到所有节点。
• 检查并开启同步配置：

[apim.gateway.sync_runtime_artifacts]
enable = true

开启后网关会定期从配置中心拉取最新API配置，实现跨节点热部署。

4. 手动部署后的触发方式 #

若必须手动将API的Synapse配置文件放到synapse-configs/default/api目录：

• 确保文件名符合规范（如<API_NAME>-<VERSION>.xml），且XML内容无语法错误（错误会导致部署失败，需查看日志排查）。
• 可在Carbon控制台的Main → Manage → API Gateway → API Deployments页面点击Reload按钮，强制网关扫描并部署新API，无需重启服务。

5. 日志排查部署失败原因 #

若上述操作无效，查看<APIM_HOME>/repository/logs/wso2carbon.log，搜索API deployment或synapse关键字，排查是否存在权限不足、依赖缺失、配置语法错误等问题——这类问题会导致热部署失败，需修复后再尝试部署。

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