Jenkins RESTful API 定制化

目录

前言：

1.背景

2.Jenkins 原生 Remote access API

3.Jenkins api wrappers

4.定制 Jenkins RESTful API

Controller 层

service 层

model 层

---

前言：

Jenkins RESTful API 定制化是指利用 Jenkins RESTful API 来定制和扩展 Jenkins 的功能。Jenkins RESTful API 提供了一系列的接口，可以用于获取 Jenkins 的状态信息、创建和管理 Jenkins 的任务等。

1.背景

Jenkins 具有丰富的插件生态，足以满足我们日常工作的需求；如果我们想通过具体的 Jenkins 任务直接对外提供服务，而我们不想将内部的具体实现对外暴露 (否则，需添加对应的用户权限，通过页面执行 job)；可以对外直接提供接口，第三方直接调用接口（比如提供给开发，提测前回归冒烟用例集），执行相应的 Jenkins 任务并获取任务结果。

2.Jenkins 原生 Remote access API

Jenkins 提供了原生的 Remote accsee API, 主要用来做：

1.检索Jenkins中信息
2.触发新构建
3.创建/复制任务

实例：

获取项目FastTest信息：
curl -u user:pwd -X POST http://ip:port/jenkins/job/FastTest/api/xml
并支持Xpath进行信息提取,详见 https://issues.jenkins-ci.org/browse/JENKINS-626

触发新的构建（带参数构建）：
curl -u user:pwd -X POST http://ip:port/jenkins/job/FastTest/buildWithParameters -d "environment=运行环境&module=模块&mailer=收件人"

该接口响应头信息：
* upload completely sent off: 94 out of 94 bytes
< HTTP/1.1 201 Created
< Server: Apache-Coyote/1.1
< X-Content-Type-Options: nosniff
< Location: http://ip:port/jenkins/queue/item/111/
< Content-Length: 0
< Date: Wed, 05 Oct 2016 07:39:39 GMT
< 
* Connection #0 to host 10.210.228.50 left intact

但是该接口无任何返回信息。

完整的 Remote access API wiki 可以通过如下获取：

curl  -u user:pwd -X POST http://ip:port/jenkins/job/FastTest/api/ > /Users/hugang/Desktop/jenkins_api_wiki.html

原生的接口，功能较为简单、不友好，需封装 Jenkins 的 api，提供有价值的接口返回信息。

3.Jenkins api wrappers

Jenkins api wrappers 有多种编程语言实现, 可以很方便的操作 Jenkins，具体如下：

Node.js: jenkins-api - npm

ruby: jenkins_api_client | RubyGems.org | your community gem host

python: python-jenkins · PyPI

java: