前几天公司要求将jira创建项目和用户等功能集成到自己的任务管理系统中,记录一下实现过程。
jira接口的外部调用有一个系统自带的插件:Atlassian JIRA - Plugins - REST Plugin,有一系列的rest api接口,由于是系统自带的,所以不需要额外下载。
jira 的api地址: The Jira Cloud platform REST API (atlassian.com)
调用的话推荐使用 HttpClient,因为jira rest api的接口包含了put和Delete请求类型。
插件的maven引入:
<dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.5.3</version> </dependency>
jira rest api的调用需要在请求头传输权限信息,所以需要设置请求头部,以post请求为例:
CloseableHttpClient client = HttpClients.createDefault(); HttpPost post = new HttpPost("http://IP:HOST/rest/api/2/**"); post.setHeader("Accept", "application/json"); post.setHeader("Content-Type", "application/json;charset=UTF-8"); post.setHeader("Authorization", auth);
其中的auth就是权限信息,组成是:”Basic jira管理员账号:密码“,Basic是固定的,后面的内容需要转base64
Base64 base64 = new Base64();
try {
//"root:123456"是jira账号拼密码
return "Basic " + base64.encodeToString("root:123456".getBytes("UTF-8"));
} catch (UnsupportedEncodingException e) {
System.err.println(e.getMessage());
return null;
}
注意:"Basic " 是有一个空格的!
设置了请求头部以后,就可以根据api中接口需要的参数进行调用了。
还有一点是rest api不同接口的返回状态码是不一样,可以将状态码设置为形参传进去。
例如:Create group 是post请求 成功状态码是201
Add actors to project role也是post请求 成功状态码是200。
所以方法定义为:
public static JSONObject sendPost(String url, JSONObject params, String auth,int successCode)
另外,jira版本不同,rest api的版本和url也会有差异,记得查看自己jira REST Plugin版本的url。