DataAPIEntryScoreプラグイン(その1)

Data APIを使って、Facebookの「いいね!」のような機能を実現するプラグインを作りました。
今日は、インストールの手順と、追加されるエンドポイントおよびテンプレートタグを解説します。
JavaScriptで操作する方法は、明日の記事で公開します。

なお、この記事はMovable Type Advent Calendarの16日目です。

1.プラグインのインストール

プラグインのファイルは以下からダウンロードします。

DataAPIEntryScore_0_10.zip

ダウンロードしたZipファイルを解凍すると、「plugins」と「mt-static」のフォルダができます。
これらのフォルダを、Movable Typeのインストール先ディレクトリにアップロードします。

2.追加されるエンドポイント

このプラグインをインストールすると、「http://your-host/path-to-mt/mt-data-api.cgi/v1/:site_id/entries/:entry_id/like」のエンドポイントが追加されます。
「your-host」および「path-to-mt」の部分は、ご自分のMovable Typeのインストール先に合わせて読み替えます。
また、「:site_id」と「:entry_id」は、それぞれウェブサイト（またはブログ）のID／記事のIDに置き換えます。
エンドポイントにアクセスする際のHTTPのメソッドに応じて、以下の動作になります。

ID	HTTPのメソッド	動作
listLikesForEntry	GET	記事に「いいね!」をつけたユーザーの情報を取得
addLikeToEntry	PUT	記事に「いいね!」をつける
removeLikeFromEntry	DELETE	記事から「いいね!」を削除

なお、addLikeToEntryとremoveLikeFromEntryは、Data APIで認証している状態で実行する必要があります。

3.追加されるテンプレートタグ

「いいね!」を付けたユーザーの一覧を出力するブロックタグとして、「MTEntryLikedAutors」というテンプレートタグを追加します。
このタグのブロックの中では、MTAuthor系のテンプレートタグを使って、個々のユーザーの情報を出力することができます。

なお、「いいね!」を付けたユーザーの総数は、以下のテンプレートタグで出力することができます。

<$mt:EntryScore namespace="data_api_like"$>