-オープンソースのSNSエンジン OpenPNEプロジェクト-

OpenPNE 3.1 機能紹介 #1 – WebAPI

06 / 08 月曜日 2009

OpenPNE 開発チームの海老原です。

現在 OpenPNE 3.1 には、 OpenPNE 3.2 に向けて機能追加・改善が積極的におこなわれています。
そこで、 OpenPNE 3.1 に追加された、または追加される予定の機能について、不定期ではありますが紹介していこうと思います。

栄えある第一回目は、 WebAPI 機能です。

WebAPI 機能について

WebAPI 機能を利用することで、日記などのコンテンツに対して取得、追加、更新、削除といった操作をおこなうことができます。
OpenPNE 3 における WebAPI は拙作の opWebAPIPlugin によって提供されています。このプラグインは OpenPNE 3.0 から存在していましたが、実験的なものであり、機能としてはかなり貧弱でした。

OpenPNE 3.1.0 リリースのお知らせ」にて宣言したように、 OpenPNE 3.1.1 は「連携制の強化」を目標に現在開発が進められています。そこで opWebAPIPlugin の刷新をはかり、 OpenPNE 3 と他アプリケーションとの連携による可能性を広げていければ、と考えています。

利用できる WebAPI

開発中の opWebAPIPlugin では、以下のような API が供給されます。

  • メンバー
    • メンバー一覧の取得(登録日やニックネームなどによる絞り込み可)
    • 個別のメンバー情報の取得
  • コミュニティ
    • コミュニティ一覧の取得(登録日やコミュニティ名などによる絞り込み可)
    • 個別のコミュニティ情報の取得
    • 新規コミュニティの追加
    • コミュニティの編集
    • コミュニティの削除
  • コミュニティメンバー
    • コミュニティメンバー一覧の取得(登録日などによる絞り込み可)
  • コミュニティトピック
    • コミュニティトピック一覧の取得(登録日やトピック名などによる絞り込み可)
    • 個別のコミュニティトピック情報の取得
    • 新規コミュニティトピックの追加
    • コミュニティトピックの編集
    • コミュニティトピックの削除
  • コミュニティトピックコメント
    • コミュニティトピックコメント一覧の取得(登録日やコメント本文などによる絞り込み可)
    • 個別のコミュニティトピックコメント情報の取得
    • 新規コミュニティトピックコメントの追加
    • コミュニティトピックコメントの削除
  • コミュニティイベント
    • コミュニティイベント一覧の取得(登録日やイベント名などによる絞り込み可)
    • 個別のコミュニティイベント情報の取得
    • 新規コミュニティイベントの追加
    • コミュニティイベントの編集
    • コミュニティイベントの削除
  • コミュニティイベントコメント
    • コミュニティイベントコメント一覧の取得(登録日やコメント本文などによる絞り込み可)
    • 個別のコミュニティイベントコメント情報の取得
    • 新規コミュニティイベントコメントの追加
    • コミュニティイベントコメントの削除
  • 日記
    • 日記一覧の取得(登録日やタイトルなどによる絞り込み可)
    • 個別の日記情報の取得
    • 新規日記の追加
    • 日記の編集
    • 日記の削除
  • 日記コメント
    • 日記コメント一覧の取得(登録日やコメント本文などによる絞り込み可)
    • 個別の日記コメント情報の取得
    • 新規日記コメントの追加
    • 日記コメントの削除

利用方法

WebAPI 機能は Google Data API (以下、 GData)に準拠するように作られています。この GData の根底にあるのは Atom Publishing Protocol (以下、 AtomPub)というプロトコルです。つまりこれらのプロトコルに関する知識があれば、簡単に WebAPI を利用することができます。

開発中ソースコードの入手

opWebAPIPlugin は GitHub 上で開発がおこなわれています。
http://github.com/ebihara/opWebAPIPlugin/tree/master

現時点ではラフなコードになっているのでかなり扱いづらいとは思いますが、ご興味がある方は是非 fork してみてください!

コメント:0

コメントフォーム
お名前やメールアドレスを記録しますか?

トラックバック:0

この記事のトラックバックURL
http://www.openpne.jp/archives/2295/trackback/

ページの先頭に戻る