如何在GitLab流水线中调用API导出功能标志至JSON文件

核心实现思路：GitLab API + CI/CD变量 + 命令行工具 #

直接通过GitLab功能标志API获取数据，在流水线Job中用curl调用API，结合jq处理输出并生成JSON文件，具体步骤如下：

1. 配置API访问令牌

   • 创建一个具备read_api权限的访问令牌：推荐使用项目级访问令牌（权限范围更精准），也可使用个人访问令牌（PAT）。
   • 进入项目「设置>CI/CD>变量」，添加名为GITLAB_API_TOKEN的变量，勾选「掩码」选项防止令牌泄露。

2. 编写流水线Job
   使用自带curl和jq的镜像（比如alpine/git），编写Job调用API并生成JSON文件，同时可将文件作为流水线制品保存。

generate-feature-flags-json:
  image: alpine/git:latest
  stage: build
  script:
    # 调用GitLab API，过滤所需字段（名称、状态、描述）并生成JSON
    - curl --header "PRIVATE-TOKEN: $GITLAB_API_TOKEN" "https://gitlab.com/api/v4/projects/$CI_PROJECT_ID/feature_flags" | jq '[.[] | {name: .name, state: .state, description: .description}]' > feature_flags.json
    # 验证文件内容（可选）
    - cat feature_flags.json
  artifacts:
    paths:
      - feature_flags.json
    expire_in: 1 week

优化方案 #

• 复用内置变量：用GitLab CI内置变量$CI_PROJECT_ID替代手动设置的项目ID，适配不同项目时无需修改代码。
• 复杂数据处理：如果需要对API返回做更复杂的转换（比如映射状态值、过滤特定标志），可以写个简单的Python/Shell脚本替代纯jq，代码可读性更高。
• 自托管GitLab适配：如果用的是自托管实例，把API地址改成https://你的GitLab地址/api/v4/projects/$CI_PROJECT_ID/feature_flags。

注意事项 #

• 确保令牌仅拥有read_api权限，遵循最小权限原则。
• 若API调用失败，可在脚本开头加set -e让Job自动终止，避免生成无效文件。

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