微服务架构下如何在Git中共享api.yml文件？

下面是几种能替代手动复制粘贴的可行方案，按需选择：

1. 抽成独立Git仓库作为公共依赖 #

把api.yml单独放到一个独立的Git仓库里，专门维护API规范版本。其他微服务可以通过两种方式引入：

• Git子模块：在每个微服务仓库里添加该仓库作为子模块，拉取时会同步api.yml文件。命令示例：

  # 添加子模块
  git submodule add <api-spec仓库地址> src/main/resources/api-spec
  # 后续更新api.yml时，在微服务仓库执行
  git submodule update --remote
  

  优点是版本关联清晰，能精准控制每个微服务使用的api.yml版本；缺点是需要团队熟悉子模块操作。
• 打包成依赖包：如果是Java生态，把api.yml放到一个空的maven/gradle项目里，打包成jar上传到私有仓库（比如Nexus），其他微服务在pom.xml/build.gradle中引入这个依赖，构建时会自动把api.yml加载到资源目录。更新时只需要升级依赖版本即可。

2. 构建阶段自动拉取最新文件 #

利用构建工具的自定义任务，在微服务构建前自动从指定仓库拉取最新的api.yml，无需手动操作。

• Gradle示例：在build.gradle中添加自定义任务，依赖编译阶段自动执行：

  task pullApiYml(type: Exec) {
      commandLine 'curl', '-o', 'src/main/resources/api.yml', '<api.yml的原始仓库raw地址>'
  }
  // 让编译任务依赖拉取任务
  compileJava.dependsOn(pullApiYml)
  

• Maven示例：使用wagon插件配置远程文件拉取，在pre-compile阶段执行。
  优点是无需额外维护仓库，配置简单；缺点是如果需要指定特定版本，需要调整拉取地址，版本追溯性弱。

3. 借助统一API管理平台 #

如果团队有API网关或专门的API管理平台，可以把api.yml上传到平台，配置版本管理和变更通知。每个微服务通过平台提供的接口拉取对应版本的api.yml生成Feign客户端，甚至可以配置webhook，当api.yml变更时自动触发各微服务的构建更新。
优点是适合大规模微服务场景，能统一管控API生命周期；缺点是需要额外部署和维护API管理平台。

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