当前位置: 代码迷 >> python >> Confluence WIki页面不通过API更新
  详细解决方案

Confluence WIki页面不通过API更新

热度:48   发布时间:2023-06-16 10:12:54.0

我尝试使用Rest API来更新我们的wiki页面,但即使我收到200个代码,似乎也没有发生任何事情。

我试图通过邮递员和Python来实现这一点,我在两种情况下都收到相同的服务器响应,但无济于事。 这是我的Python代码 -

curl = 'curl -u user:pass -X POST -H \'Content-Type: application/json\' ' \
           '-d \'{0}\' https://wiki.myCompany.com:8444/confluence/rest/api/content/'\
            .format(json.dumps(new))
    output = subprocess.check_output(['bash', '-c', curl])
    print(output`)

我尝试过使用POST和PUT

这是回应 -

PUT https://wiki.myCompany.com:8444/confluence/rest/api/content/
 200 OK       26.47 kB       655 ms
View Request View Response
HEADERS
Content-Encoding: gzip
Content-Length: 6578
Content-Security-Policy: frame-ancestors 'self'
Content-Type: text/html;charset=UTF-8
Date: Wed, 15 Feb 2017 20:24:46 GMT
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=DBCAA4C03DC489A720B8A59D755BD22A; Path=/; Secure; HttpOnly
Vary: User-Agent
X-Accel-Buffering: no
X-Asen: SEN-3386858
X-Ausername: username
X-Confluence-Request-Time: 1487190286413
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Seraph-Loginreason: OK
X-Xss-Protection: 1; mode=block

BODYview raw


<!DOCTYPE html>
<html>
  <head>
    <title>Dashboard - myCompany Wiki</title>
    <meta http-equiv="X-UA-Compatible" content="IE=EDGE,chrome=IE7">
      <meta charset="UTF-8">
        <meta id="confluence-context-path" name="confluence-context-path" content="">
          <meta id="confluence-base-url" name="confluence-base-url" content="https://wiki.myCompany.com:8444">
            <meta id="atlassian-token" name="atlassian-token" content="abcd227f923fa6d5cce068a25de3bb4a3a3ceca4">
              <script type="text/javascript">
        var contextPath = '';
</script>

..... A lot more html .... but nothing relating to Body or Body.Storage...

我的JSON正确形成并包含页面ID - 这是它的开始....

{"id":"28870287","type":"page","status":"current","title":"Automated QA Results - Android","body":{"storage":{"value":"<p>These are the results of every git merge...}}

有谁知道为什么没有发生什么?

我之前通过请求库试过这个 - 我得到了相同的200响应代码。 我只是看到你们是否注意到调用本身而不是执行错误

   # output = requests.post('https://{0}/confluence/rest/api/content'.format(jirasite),
#                     data=(json.dumps(new)),
#                     auth=('user', 'pass'),
#                     headers=({'Content-Type': 'application/json'}))

****新的更新****

我正在尝试从字面上的Confluence API页面上给出的股票卷曲值

'{"id":"28870287","type":"page","title":"new page","space":{"key":"TST"},"body":{"storage":{"value":"<p>This is the updated text for the new page</p>","representation":"storage"}},"version":{"number":2}}'

仍无济于事......我完全失去了......

******再次更新******

我将发布我目前正在使用的代码

    r = requests.get('{0}/rest/api/content/28870287?expand=body.storage,version'.format(conflu_site),
                 auth=(test_user, test_pass)).text

    print(r) # This works as expected

new = '{\"id\":\"28870287\",\"type\":\"page",\"title":\"Automated QA Results - Android\",\"space\":{\"key\":\"TST\"},' \
      '\"body\":{\"storage\":{\"value\":\"<p>This is the updated text for the new page</p>\",' \
      '\"representation\":\"storage\"}},\"version\":{\"number\":2}}'

update_response = requests.put('{0}/confluence/rest/api/content/28870287/'.format(conflu_site),
                                data=new,
                                auth=(test_user, test_pass),
                                headers=({'Content-Type': 'application/json'}))

print("Update Confluence Response: " + str(update_response))

我接受了lukegv的回答,因为它最终给了我一些错误消息,我可以使用它来获得最终解决方案。 更重要的是,我发布我的脚本,以防任何人遇到这个并且由于缺乏confluence API的文档而感到愤怒。

@lukegv是对的 - 即使更新汇合的文档说使用它:

http://localhost:8080/confluence/rest/api/content/3604482

如果您使用的是wiki站点,那么您应该使用它

http://localhost:8080/rest/api/content/3604482

第二个问题是您需要增加页面的版本号才能更新。 要做到这一点,你需要像这样调用expand = version。

get_json = json.loads(requests.get('{0}/rest/api/content/28870287?expand=body.storage,version'.format(conflu_site),
                 auth=(test_user, test_pass)).text)

以下是我最终实现代码以使其工作的方式。

# This is the bare minimum that it takes to update a wiki page
update_templete = json.loads('{"id":"28870287","type":"page","body":{"storage":' \
              '{"value":"Test","representation":"storage"}},"version":{"number":2}}')

# This is used to get the current body of the wiki page 
get_json = json.loads(requests.get('{0}/rest/api/content/28870287?expand=body.storage,version'.format(conflu_site),
                 auth=(test_user, test_pass)).text)

# This increments the version number by one
update_templete["version"]["number"] = get_json["version"]["number"] + 1

# This saves the current page's body as a string
body = str(get_json["body"]["storage"]["value"])

# Use this to change the body however you see fit 
new_body = do_Stuff(body) 

# Update the templete's body json with the new body
update_templete["body"]["storage"]["value"] = new_body

# updates the confluence wiki site with the page body
update_response = requests.put('{0}/rest/api/content/28870287/'.format(conflu_site),
                                data=json.dumps(update_templete),
                                auth=(test_user, test_pass),
                                headers=({'Content-Type': 'application/json'}))

首先,请检查Confluence实例的基本URL,因为默认情况下它看起来像xxx.xxx.xxx.xxx:1990/confluence ,但是可以摆脱上下文confluence 在您的示例中,您使用wiki.myCompany.com:8444作为名为jirasite东西,并且仍然在REST API url rest/api之前添加confluence 如果您使用正确的API端点,则永远不应该获得HTML响应。

然后,请确定您要使用的API方法。 要新内容,您必须向rest/api/content发送POST请求,但要现有内容,您必须向rest/api/content/{contentId}发送PUT请求。

我刚刚注意到,您在curl中使用-u选项,并使用请求库的auth方法进行身份验证。 我不太确定,但我认为通过这些技术进行身份验证是不可能的。 Atlassian列出他们文档中 ,我认为,您必须自己实现他们的基本身份验证

一些其他疑难解答提示

Atlassian提供了一个来测试API请求。 如果您无法在Confluence实例中安装插件,则可以使用浏览器扩展(例如 )。 这样,您可以向Confluence发送请求,而无需关心身份验证。