REST APIとは何ですか?

APIはアプリケーションプログラミングインターフェースです。RESTは「REpresentational State Transfer」の略で、アプリケーションのデータを相互に関連するオブジェクトやコレクションとしてモデル化し、アクセスするための概念のセットです。WordPress REST APIは、投稿、ページ、分類、その他の組み込みWordPressデータタイプを表すRESTエンドポイント(URL)を提供します。アプリケーションは、これらのエンドポイントにJSONデータを送信および受信して、サイト上のコンテンツをクエリ、変更、作成できます。JSONはオープンスタンダードのデータフォーマットで、軽量で人間が読みやすく、JavaScriptのオブジェクトのように見えます。APIからコンテンツをリクエストしたり、コンテンツを送信したりすると、レスポンスもJSON形式で返されます。JSONは多くのプログラミング言語で広くサポートされているため、開発者はクライアントサイドJavaScript(ブロックエディタのような)でWordPressアプリケーションを構築したり、モバイルアプリやデスクトップまたはコマンドラインツールとして構築したりできます。

REST APIはWordPressが提供する多くのAPIの1つに過ぎません。これらの追加APIに関するドキュメントはこちらで見つけることができます。

WordPress REST APIの使用

WordPressはすでにサイト構築のための豊富なツールとインターフェースを提供しており、サイトが期待通りに動作している場合、REST APIを使用する必要はありません。WordPressテーマやプラグインを構築するためにREST APIを使用する必要はありません。

ただし、テーマ、プラグイン、または外部アプリケーションをクライアントサイドJavaScriptアプリケーションとして、またはPHP以外の言語でスタンドアロンプログラムとして記述したい場合、アプリケーションはWordPressサイト内のコンテンツにアクセスするための構造化された方法が必要です。HTTPリクエストを行い、JSONを解釈できる任意のプログラミング言語は、PHP、Node.js、Go、JavaからSwift、Kotlinなどを使用してREST APIを介してWordPressと対話できます。

バニラJavaScriptやjQueryをテーマやプラグイン内で使用している場合でも、REST APIはadmin-ajaxよりもサイトのコンテンツと対話するためのより予測可能で構造化された方法を提供し、必要なデータにアクセスする時間を短縮し、より良いユーザーエクスペリエンスを作成する時間を増やすことができます。

WordPressにデータを出入りさせるための構造化され、拡張可能でシンプルな方法を求めている場合、REST APIを使用することをお勧めします。

そのシンプルさにもかかわらず、REST APIは最初はかなり複雑に感じるかもしれませんので、このハンドブックでは、全体のパズルの各部分を説明するためにそれを小さなコンポーネントに分解しようとします。

次のステップ

REST APIの機能の背後にある主要な技術概念に慣れ親しんでください。

APIリソースと特定のデータをクエリする方法については、REST APIの使用セクションで詳しく学んでください。

デフォルトのルートとメソッドの動作に慣れたら、REST APIの拡張セクションでAPIに新しいデータを追加したり、既存のレスポンスオブジェクトを強化および操作する方法を見つけてください。

デフォルトで利用可能なリソースとルートの包括的な概要については、APIリファレンスを確認してください。