aequitas/http-api-resource

HTTP API Resource

Concourse资源镜像，用于与简单HTTP（REST/JSON）API进行交互。该资源适用于仅需单请求交互的API场景，并非通用解决方案；若API较复杂，建议参考自定义资源开发指南。

近期变更

• 2018年9月：修复检查时的错误（报告者：@OvermindDL1）
• 2018年2月：修复构建详情加载问题（@scottasmith，报告者：@pranaysharmadelhi）
• 2018年2月：添加JSON中UTF-8支持（@masaki-takano）
• 2018年1月：修复Concourse 3.1.1兼容性问题（@hfinucane）
• 2018年1月：添加许可证
• 2017年1月：支持列表的递归插值

源配置

大多数source选项也可在params中用于特定动作，允许使用不同URL路径（例如POST和GET使用不同端点）。params中的选项优先级高于source。

• uri：必填。请求使用的统一资源标识符（URI）。
  示例：https://www.hipchat.com/v2/room/1234321/notification

• method：可选。请求方法，如GET、POST、PATCH（默认值：GET）。

• headers：可选。包含请求头的对象。
  示例：

  yaml
  headers:
      X-Some-Header: some header content
  

• json：可选。随请求发送的JSON数据，会自动设置application/json头。

• debug：可选。启用脚本调试日志，接受布尔值（默认值：false）。

• ssl_verify：可选。布尔值或SSL CA内容（默认值：true）。

• form_data：可选。包含表单字段/值对的字典，值会转换为JSON并进行URL编码。

行为

目前该资源仅支持out动作，in和check动作将在后续版本添加。

变量插值

所有选项支持通过Python字符串格式化进行变量插值。
简言之，变量需用单花括号包裹（区别于Concourse的双花括号），例如：构建编号 {BUILD_NAME} 已通过。

可用变量包括构建元数据（BUILD_NAME、BUILD_JOB_NAME、BUILD_PIPELINE_NAME、BUILD_ID）以及合并后的source/params对象。插值将在两个对象合并后执行。
注意：包含插值变量的选项需用双引号"包裹。

参考下方HipChat示例了解用法。

示例

向HipChat发送通知

该示例展示如何使用构建元数据和params字典进行变量插值，以及如何通过Concourse变量设置认证头。

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构建

触发job_name任务，并将参数package设置为test。
更多信息：[***]

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