読者です 読者をやめる 読者になる 読者になる

tohokuaikiのチラシの裏

技術的ネタとか。

Confluenceのプラグイン開発を承ります。ご連絡はこちらのホームページからお願いいたします。

ConfluenceのREST APIを作ってみる - 序章

confluence

ConfluenceのAPIはいろいろあって、

  1. XML-RPC
  2. JSON-RPC
  3. REST

の順で整備されているみたい。

JSON-RPCなんかは、ConfluenceのSDKではRESTブラウザが管理画面から使えるようになっている。
http://localhost:1990/confluence/plugins/servlet/restbrowser/

今後のAPIについて

Atlassianのページによると、
Confluence JSON-RPC APIs - Confluence Development - Atlassian Developer Documentation

We are developing a new REST API that will replace our existing APIs. We recommend plugin developers use the REST API where possible.

ということで、今後はREST APIで統一していくという事のようだ。

ということで、APIを追加するにあたってREST APIを作ってみる。

ConfluenceのREST APIを使ってみる

使う場合はこちら。
Confluence REST API documentation

ただし、Confluenceのバージョンによってはここにあっても無かったり、SDKの管理画面RESTブラウザにあっても実態は無かったりするので注意が必要。

無いどころか
http://localhost:1990/confluence/rest/likes/1.0/content/{pageId}/likes
みたいにあったりもするので逆に注意が必要になる。この辺りはAtlassianのドキュメントチームに頑張っていただくしか。。。

開発 --- JIRAやBambooも共通のAPIの作り方

開発する場合。APIなのでHTMLに左右されることなく、データとのやり取りだけをフレームワーク化しやすいので、JIRAなんかとも共通の開発手法&ドキュメントになっている。ドキュメントはこちら、
REST Plugin Module - Atlassian Developers