如何实现Jenkins构建时调用外部服务器REST API

该操作完全可以实现，Jenkins支持在构建流程的任意节点（构建前、构建中、构建结束后）调用外部服务REST API，你可以根据当前使用的Jenkins任务类型选择对应配置方案。

方案1：原生脚本调用（无需额外安装插件） #

不管是自由风格（Freestyle）任务还是流水线（Pipeline）任务，都可以直接通过执行shell/批处理脚本，用curl等命令行工具发HTTP请求，是最通用的方案。

• 自由风格任务配置步骤：
  • 进入任务配置页，找到需要触发API的位置：构建前触发就找「构建环境」前置步骤，构建中触发就找「构建步骤」，构建结束不管成功失败都触发就找「构建后操作」
  • 新增构建步骤，Linux节点选「执行shell」，Windows节点选「执行Windows批处理命令」
  • 在命令编辑框写入调用API的命令即可，示例：

# 基础GET请求示例
curl -X GET http://你的自有服务域名/接口路径
# 带JSON参数、鉴权头的POST请求示例，可直接引用Jenkins内置环境变量传递构建信息
curl -X POST http://你的自有服务域名/构建通知接口 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 你的接口鉴权Token" \
  -d '{"buildId":"${BUILD_ID}","jobName":"${JOB_NAME}","status":"running"}'

脚本里可以直接引用Jenkins内置环境变量（比如构建号、任务名、构建结果等），把构建上下文同步给你的自有服务；如果需要接口调用失败时标记构建异常，可以给curl加-f参数，接口返回非2xx状态码时步骤会自动判定为失败。

• 流水线（Pipeline）任务配置：
  直接在对应流程块中插入sh步骤执行curl命令即可，示例：

pipeline {
  agent any
  stages {
    stage('构建中通知自有服务') {
      steps {
        sh '''
          curl -f -X POST http://你的自有服务域名/构建通知接口 \
            -H "Content-Type: application/json" \
            -d '{"buildNum":${BUILD_NUMBER},"status":"building"}'
        '''
      }
    }
  }
  // 构建结束后（无论成功失败）触发通知
  post {
    always {
      sh 'curl -f -X GET http://你的自有服务域名/notify?result=${BUILD_STATUS}'
    }
  }
}

方案2：通过HTTP Request插件可视化配置 #

如果你不想手写curl脚本，可以在Jenkins插件管理中搜索安装HTTP Request插件，安装完成后支持可视化配置API请求参数：

• 自由风格任务中会新增「HTTP Request」构建步骤选项，直接在表单里填请求地址、方法、鉴权信息、参数即可，不需要手写命令
• 流水线任务中可以用插件封装的方法调用，示例：

httpRequest acceptType: 'APPLICATION_JSON',
  contentType: 'APPLICATION_JSON',
  httpMode: 'POST',
  requestBody: '{"buildId":"${BUILD_ID}"}',
  url: 'http://你的自有服务域名/接口路径',
  validResponseCodes: '200' // 配置合法响应码，匹配不到会自动标记步骤失败

• 提前确认Jenkins运行节点（主节点/实际执行构建的从节点）的网络和你的自有服务器API地址连通，没有防火墙、安全组的端口拦截
• 接口鉴权用的Token、密钥不要硬编码在脚本里，建议统一存到Jenkins「凭据管理」中，通过凭据ID在脚本中引用，避免敏感信息泄露
• 如果需要在构建队列排队、任务被手动取消等非构建执行阶段触发API，可以搭配Jenkins的Webhook插件配置全局事件触发规则。

内容的提问来源于stack exchange，提问作者seok0.2