Movable Type CMSプラットフォーム Movable Type
ドキュメントサイト

Blogブログ

詳説 Data API 2.0 Vol.1: v1.0 との違い

現在開発中の Movable Type 6.1 では、Data API が大幅にパワーアップします。では、具体的にどうパワーアップするのか?

不定期連載になりますが、「詳説 Data API 2.0」シリーズとして、新しくできるようになったこと。変更されたところ。などについての記事を公開していきます。

連載の第一回目となる今回は「v1.0 との違い」について説明します。

エンドポイントが違う

Data API v1.0 との大きな違いは何でしょうか?

Data API は、バージョン情報を URL に含んでいるので、API を呼び出す際の URL が変わります。

v1.0: http://example.com/mt-data-api.cgi/v1/sites/1

v2.0: http://example.com/mt-data-api.cgi/v2/sites/1

v2.0 の API を利用するときは、上記のように /v1//v2/ に変更する必要があります。逆を言うと、v1 の API を使い続けたい場合は、Data API が v2.0 になっていても、/v1/ を指定すれば互換性が保証されていることを意味します。(ただし、古い API が永遠に残ることはなく、いずれ削除されることが多いです。)

API で出来ることが3倍以上に

呼び出しのエンドポイントの違い以外で大きな点と言えば、なんと言っても API の数が v1.0 と比較して3倍以上になるということです。

具体的には、主に以下のようなことができるようになります。

  • ほぼ全てのオブジェクトについて、作成・更新・取得・削除ができるように
  • ウェブサイト・ブログ単位で Data API のアクセスを禁止することができるように
  • ウェブサイト・ブログを横断した記事の検索ができるように
  • インデックス・アーカイブテンプレートの再構築ができるように

次回は、最も強化された部分とも言える[アイテム]周りのエンドポイントを中心に解説します。

  • このエントリーをはてなブックマークに追加