confluence提供了開放的REST API,可以使用REST API與Confluence實體(例如頁面和博客文章,空間,用戶,組等)進行交互。傳送門 Confluence Cloud REST API
本文主要會針對Confluence Cloud REST API中的開放接口進行簡要的介紹,並以創建confluence頁面為例子描述如何使用其開放的RestAPI
掃了壹眼接口文檔,開放的接口實在太多了,就隨便挑幾個列出來,其他的去官方文檔自取吧。。
GET / wiki / rest / api / space
header :Accept: application/json
POST /wiki/rest/api/space
BODY PARAMETERS
key REQUIRED string
name REQUIRED string
description
permissions
GET /wiki/rest/api/content
header :Accept: application/json
GET /wiki/rest/api/content/{id}
header :Accept: application/json
POST /wiki/rest/api/content
BODY PARAMETERS
略,自己看
不想寫了,晚點補充
以創建壹個confluence為例來介紹如何使用該API,此次示例基於jmeter(postman也可以,用法同理)
直接使用RESTAPI的時候需要進行身份認證,方法和JIRA壹樣,說明書在此 身份驗證方法
步驟如下:
API中創建內容的URL為 /wiki/rest/api/content
在這裏經過調試發現了壹個坑,填URI的時候路徑帶了/wiki,怎麽都跑不通,後來看了別人的教程,別人的教程裏面URI裏不帶/wiki,於是我也去掉後再次調試,就能調通了。
因此請求體用下圖壹次性說明,post body具體怎麽填詳見API,有需求來看我文章的人肯定能看懂API了
對幾個字段進行說明:
1、host:填妳目前使用的confluence的域名
2、內容編碼:title如果是有中文,壹定要填入utf-8。填在頭裏也可以
3、id:id為自己定義的壹串數字,長度為8,經過測試發現,並沒有什麽卵用,confluence會自己生成id
4、ancestors內的id:重要,是妳創建的頁面的父頁面的id
5、value:填的是妳要創建的頁面的html編碼標簽,如果要創建壹個帶表格的頁面,就要寫成圖裏這樣
6、key空間的key,可以從空間管理中找到,空間管理中的“標識”字段
按照以上方法,請求接口就可以在confluence上看到創建的頁面了
出來的頁面: