pirogoeth/concourse-http-api-resource

HTTP API资源镜像

镜像概述

本镜像为Concourse CI的资源类型，用于在流水线中与简单的HTTP（REST/JSON）API进行交互。适用于单请求的API操作场景，若需复杂API交互，建议参考Concourse官方文档实现自定义资源。

核心功能

• 支持GET、POST、PATCH等HTTP请求方法
• 可配置请求头、JSON数据、表单数据
• 支持变量插值（包含构建元数据如BUILD_NAME、BUILD_ID等）
• 提供SSL验证开关及自定义CA证书支持
• 支持调试日志输出

使用场景

• Concourse流水线中发送通知（如HipChat、Slack等）
• 触发外部系统构建（如Jenkins）
• 调用外部API获取或提交数据

配置说明

源配置（Source Configuration）

source和params中的选项可通用，params选项优先级更高：

• uri：必填，请求的URI地址
• method：可选，HTTP方法（默认GET）
• headers：可选，请求头字典
• json：可选，JSON请求体（自动设置Content-Type为application/json）
• debug：可选，调试日志开关（默认false）
• ssl_verify：可选，SSL验证开关或CA证书内容（默认true）
• form_data：可选，表单数据字典（值会转为JSON并URL编码）

变量插值

支持Python字符串格式化语法（单花括号），可用变量包括构建元数据（BUILD_NAME、BUILD_JOB_NAME等）及source/params合并后的参数。含插值的选项需用双引号包裹。

示例

向HipChat发送通知

yaml
resource_types:
  - name: http-api
    type: docker-image
    source:
      repository: aequitas/http-api-resource
      tag: latest

resources:
  - name: hipchat
    type: http-api
    source:
      uri: https://www.hipchat.com/v2/room/team_room/notification
      method: POST
      headers:
        Authorization: "Bearer {hipchat_token}"
      json:
        color: "{color}"
        message: "流水线 {BUILD_PIPELINE_NAME} 任务 {BUILD_JOB_NAME}（构建号 {BUILD_NAME}）{message}！"
      hipchat_token: {{HIPCHAT_TOKEN}}

jobs:
  - name: 测试并通知
    plan:
      - task: 构建
        file: ci/build.yaml
        on_success:
          put: hipchat
          params:
            color: green
            message: 执行成功
        on_failure:
          put: hipchat
          params:
            color: red
            message: 执行失败

触发Jenkins构建

yaml
resources:
  - name: jenkins-trigger-job
    type: http-api
    source:
      uri: [***]
      method: POST
      form_data:
        json:
          parameter:
            - name: package
              value: test

jobs:
  - name: 测试并触发构建
    plan:
      - task: 构建
        file: ci/build.yaml
      - put: jenkins-trigger-job