リックソフトブログ

2022年12月16日

REST API で Confleunce(コンフルエンス) のページを生成(Server版)

Author

樋口 晃 Akira Higuchi

樋口 晃</mt:Var>

  

Jira Softwareを導入検討されているお客様に商品説明をしていると、「他システム連携はできますか?」と良く聞かれます。

バッチ処理を定期的に実行して、レポートをConfluence のページに出力するなど連携が可能です。

今回は、Jira Server版をご利用の方向けに、Rest Remote APIを使ってConfluenceにページを作成する方法をご紹介します。

Confluence(サーバー版)のアトラシアンドキュメント

Confleunce (サーバー版)の REST API の詳細については、下記のAtlassian の下記ドキュメントを参照して下さい。

Python のサンプル

下記の Python を実行すると、ページが作れます。BASE_URL ~ AUTH は ご利用状況に応じて、変更して下さい。

Windows の Python 2.7.11 , Confluence 5.9 で動作確認をしました。

ページの検索

http://CONFLUENCE のサーバーURL /rest/api/content に GET メソッドで通信する事でページを検索できます。

パラメータにスペースキーと、タイトルを指定しているので該当するページが有れば、レスポンスの中のJSONデータに情報が格納されます。expand パラメータで version を指定すると、バージョン情報を取得できます。

JSON データの "size" 値から検索件数を、 "version"→ "number" からバージョン番号を取得しています。

ページの作成

http://CONFLUENCE のサーバーURL /rest/api/content に POST メソッドで通信する事で、ページを作成できます。

登録データはJSON 形式で送信し、"body" → "storage" → "value" の情報がページのコンテンツとして登録されます。

HTML の閉じタグが無いなど、エラーが有ると "HTTPステータス=400, Bad Request" が返されますので、ご注意下さい。

ページの更新

http://CONFLUENCE のサーバーURL /rest/api/content/ページID に PUT メソッドで通信する事でページを更新できます。

送信した JSON データの内容によりページが更新されます。
"version"→"number" の値は、新しい値を指定する必要が有ります。

#!/usr/bin/python
# coding: utf-8
import requests
import json
from datetime import datetime
 
BASE_URL="http://onfluence.local/wiki"
SPACE_KEY="TST"
PAGE_TITLE="Rest サンプル"
AUTH=("user", "password")
HEADERS = {"content-type":"application/json"}


# ページの検索
# http://CONFLUENCEのサーバーURL/rest/api/content?title=タイトル&spaceKey=スペースキー にアクセスしてページを検索します
# (HTTP メソッドは get )
def get_page_info(space_key, page_title):
  response = requests.get(
        BASE_URL + "/rest/api/content",
        auth=AUTH,
        params={"title":PAGE_TITLE,  "spaceKey":SPACE_KEY, "expand":"version,history"})
  #http ステータスのチェック
  response.raise_for_status()
  return response


# ページの作成
# http://CONFLUENCEのサーバーURL/rest/api/content にアクセスしてページを作成します
# (HTTP メソッドは post )
def create_page():
    json_data = create_json_data()
    response = requests.post(
         BASE_URL + "/rest/api/content",
         auth=AUTH,
         data = json.dumps(json_data),
         headers=HEADERS)
    response.raise_for_status()
  
    return response

# ページの更新
# http://CONFLUENCEのサーバーURL/rest/api/content/ページID  にアクセスしてページを更新します
# (HTTP メソッドは put )

def update_page(version_num, page_id):
    # バージョン情報を追加します。
    json_data = create_json_data()
    json_data["version"] = {'number' : version_num}
    response = requests.put(
         BASE_URL + "/rest/api/content/" + page_id,
         auth=AUTH,
         data = json.dumps(json_data),
         headers=HEADERS)
    response.raise_for_status()
    return response

# json データの生成
def create_json_data():

  # page_text にページに設定したい文字列を入れて下さい。
  page_text = "<h1>REAT API のサンプルです。</h1>\n \
               <p>今の時刻です:" +  datetime.now().strftime("%Y-%m-%d %H:%M:%S") + "</p>"
   
  payload = {
              "type":"page",
              "title":PAGE_TITLE,
              "space":{"key":SPACE_KEY},
              "body":{
                "storage":{
                  "value" : page_text,
                  "representation":"storage"
                }
              }
            }
  return payload

# main function
if __name__ == "__main__":
  print "-------------- start --------------------"
  response = get_page_info(SPACE_KEY, PAGE_TITLE)
   
  response_data = json.loads(response.text)
  if response_data["size"] == 0:
    create_page()
    print "ページが無いので作成しました"
  else:
    result = response_data["results"][0]
    new_version_number = result["version"]["number"] + 1
    page_id = result["id"]
    update_page(new_version_number, page_id)
  print  "ページが有ったので更新しました (バージョン={0})".format(new_version_number)
print "-------------- end ----------------------"

※Remote API の操作を繰り返し実行すると、Confluenceに負荷がかかる事が有ります。なぜなら、人間がブラウザーで操作するよりもプログラムの方が早いからです。大量のページ作成や大量のページ検索を実施すると、結果的に「負荷テスト」を実施しているような事になります。Remote API を利用する時ははサーバーの負荷にご注意下さい。

                                   

Confluence

「現在フリープランで試行錯誤中で、全社導入のためのアドバイスが欲しい」という方、「Confluenceの活用方法をもっと詳しく知りたい」という方はこちら。

Confluence お問い合わせ

関連する製品についてはこちらをご覧ください。

Confluence

「Confluenceを試してみたい方」という方はこちら。

Confluence 無料トライアルご依頼フォーム               
                    
                                                             

本情報はブログを公開した時点の情報となります。
ご不明な点はお問い合わせください。

        

お問い合わせ         

  
本ブログのカテゴリ: Confluence
  

アトラシアン製品の導入と活用を
成功させたいなら
リックソフトのサポートが
必要です。

サードパーティ製のアドオンもサポート

サードパーティ製のアドオンもサポート

サポート

アトラシアン社ではサポート範囲外となっているサードパーティ製のアドオンをリックソフトのサポートではサポートします。

  • アトラシアン製品とサードパーティ製のアドオンとの事象の切り分け
  • 海外のアドオンベンダーとのやり取りを代行(日→英/英→日)

リックソフトのサポートは開発元が提供するサポート以上の価値があります。

サポートについて

ツールの活用を促進するアイテム

ツールの活用を促進するアイテム

各種ガイドブック

ツールを導入しただけでは成功とはいえません。利用者が効果を感じていただくことが大切です。独自で制作した各種ガイドブックはツール活用を促進します。

リックソフトからライセンス購入を頂いたお客様にはガイドブックを無料進呈いたします。

ガイドブックについて

価値あるツールの使い方

価値あるツールの使い方

研修・トレーニング

ツール操作の研修だけでなく「ウォータフォール型開発」「アジャイル型開発」のシミュレーション研修も提供。

日本随一の生産性向上にも効果のある研修サービスです。

リックソフトからライセンス購入を頂いたお客様には無料招待や割引特典がございます。

研修について

PAGE TOP