Confluence(WIKI)利用API更新页面

背景

创建测试报告之后，多个数据统计图中需要对本次需求链接的Bug从不同维度分析，每个图表中都包含issueKey需要手动修改，此页面主要提供批量更新issueKey功能

设计

• 利用Jira和Confluence的API实现
• 使用Confluence提供查询页面信息API，根据页面ID获取当前页面信息及版，并找到issueKey
• 正则匹配页面内容中需求ID并批量进行更换
• 使用JIRA查询issue的API，获取该jiraId的需求名称
  -使用Confluence页面更新API，更新页面信息，及页面标题

知识点

• JiraAPI ：
  https://developer.atlassian.com/cloud/jira/software/rest/#api-group-Sprint

• WiKiAPI ：
  https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content/{id}/property-update

• 正则表达式

具体实现

1. JiraApi通过Key获取Jira任务的名称
   API：/rest/api/2/issue/+issueKey

        //根据issueKey获取需求名称
        HttpGetUtils httpjiraget  = new HttpGetUtils(jiraurl);
        httpjiraget.setHeader("Authorization",jiraBasicAuth );
        String taskInfo = httpjiraget.getHttp(httpjiraget);
        String taskName = (String) JSONPath.read(taskInfo,"fields.summary");
        System.out.println(taskName);
     

2. API获取现有页面内容及VersionId
   API： /rest/api/content/"+pageID+"/?expand=body.storage

//获取当前页面版本
        HttpGetUtils httpwiki  = new HttpGetUtils(wikiCurPageVerUrl);
        httpwiki.setHeader("Authorization",jiraBasicAuth );
        String versioninfo = httpwiki.getHttp(httpwiki);
      //拆解版本号
      Integer currentVersion = (Integer)JSONPath.read(versioninfo, "version.number");
      //赋值新的页面版本
      Integer versionId = currentVersion + 1;
        System.out.println(versionId);

    //获取当前页面的信息
        HttpGetUtils httpwikiinfo  = new HttpGetUtils(wikiCurPageInfUrl);
        httpwikiinfo.setHeader("Authorization",jiraBasicAuth );

        String contentInfo = httpwikiinfo.getHttp(httpwikiinfo);

3. 正则匹配页面内容中需求ID并批量进行更换

//正则表达式替换所有的Key
    newhalfcontent = storage[1].replaceAll("((?<=key\\\\\">)\\S+?[^\\<]+)|((?<=linkedissues\\()[^\\)]+)",issueKey);

4. 利用WIKI的API更新页面
   API：/rest/api/content/"+pageID+"/?expand=version"

    //更新页面信息需要用到的传参
    String newContent = "{\n" +
            "    \"version\": {\n" +
            "        \"number\": "+versionId+"\n" +
            "    },\n" +
            "    \"title\": \""+issueKey+" "+taskName+" 测试综合文档"+"\",\n" +
            "    \"type\": \"page\",\n" +
            "    \"body\""+newhalfcontent;

        System.out.println(newContent);

    //更新页面信息
        String wikiUpdateUrl = "http://wiki.test.com/rest/api/content/"+pageID+"";
        HttpPutUtils httpwikiupdate  = new HttpPutUtils(wikiUpdateUrl);
        httpwikiupdate.setHeader("Authorization",jiraBasicAuth );
        String tab = httpwikiupdate.jsonPutHttp(newContent,httpwikiupdate);

5. 正则匹配小括号中的内容2种方式
   5.1 表达式： (?<=()\S+?(?=))

   
   
   

   image.png

(?<=exp)是以exp开头的字符串, 但不包含本身。
(?=exp)就匹配以exp结尾的字符串, 但不包含本身。
(?<=() 也就是以括号开头, 但不包含括号。
(?=)) 就是以括号结尾。
\S 匹配任何非空白字符。等价于[^ \f\n\r\t\v]。
+表示至少有一个字符.
? 表示非贪婪(如果没有有？则会匹配文本中第一个括号到最后一个括号之间的所有内容，如下图)

image.png

(?<=()\S+(?=)) 就是匹配以 (开头, )结尾的括号里面最少有一个非空白字符的串, 但不包括开头的(和结尾的)

预搜索就是以啥啥开头结尾但是匹配的本身不包括啥啥啥

5.2 表达式： (?<=()[^)]+

(?<=() 也就是以括号开头, 但不包含括号.
[^)] 表示匹配非)的字符，当匹配的）自动开启下一次匹配

image.png