WordPress REST APIとは何ですか?どのように使用しますか?

公開: 2022-06-30

おそらくRESTAPIについて聞いたことがあるでしょう。 WordPressユーザーがその恩恵を受けていると聞いたことがあるかもしれません。 しかし、WordPressAPIが正確に何であるか疑問に思うかもしれません。

APIがどのように機能するかを理解することは、思ったほど複雑ではありません。 APIとは何か、REST APIとは何か、サイトでWordPress REST APIを使用する方法については、読み続けてください。

APIとは何ですか?

アプリケーションプログラムインターフェイス(API)は、2つのアプリケーションが相互に「通信」するための方法です。 一方のシステムが要求を行い、もう一方のシステムがそれを実行します。 システムが受け入れるリクエストはAPIに含まれている必要があります。含まれていないと、リクエストを実行できません。

このように考えてください。 たぶんあなたは本当にお腹が空いているのでワッフルハウスに行きます。 コーヒー、卵、パンケーキを注文します。 ウェイトレスは注文を書き留め始めます—そしてパンケーキに着くと混乱します。 ワッフルハウスはパンケーキを提供していません。 彼らはワッフルを提供するだけです。

ワッフルのみを提供するAPIメニューからパンケーキを要求するシステムは空腹のままになります。

REST APIとは何ですか?

REST APIとは、インターネット用に設計された制約システムのことです。 あるWebサイトが、スケーラブルで統一された方法で別のWebサイトに情報を要求する方法について説明します。 RESTは、RoyFieldingが博士論文で定義したRepresentationalStateTransferの略です。

WordPress REST APIとは何ですか?

WordPress REST APIは、WordPressで実行されているWebサイトに対して行われたリクエストを指します。 投稿またはページのリストをリクエストすると、WordPressRESTAPIからその情報を受け取ることが期待できます。 WordPressは、ドラフト投稿や(さらに重要な)ユーザーパスワードなど、公開されていない情報を提供することはありません。

これは、ページをリロードせずにWordPressと動的にデータを交換するブロックエディターの基本です。 各エンドポイントは、JavaScript(この場合はブロック)で読み取り可能なJSON形式でデータを返します。

REST APIは、WordPressが提供するAPIの1つにすぎないことに注意してください。 たとえば、データベースAPIとメタデータAPIもあります。これらは、プラグインがサーバー上のWordPressと対話するために使用します。 コーデックスでWordPressAPIの詳細を学ぶことができます。

WordPress REST APIリクエストはどのように機能しますか?

REST APIには、ルート、エンドポイント、リクエスト、レスポンスなど、いくつかの基本的な部分があります。

ルート

ルートは、Webサイトが通信するためのURLを参照する方法です。 WordPressの一般的なルートは「/wp-admin」です。 これはRESTAPIのルートではありませんが、ブラウザがWordPress管理ダッシュボードにアクセスするために使用するルートです。 私たちの目的では、RESTAPIルートは「/wp-json」で始まります(JSONがデータの標準形式です)。

エンドポイント

エンドポイントは、ルートと着信要求タイプの組み合わせです。 複数のリクエストタイプがあるため、1つのルートで複数のエンドポイントに接続できます。 一般的なリクエストの種類には、GET(ルート上のデータの読み取り方法)とPOST(ルート上のデータの更新方法)があります。

リクエストとレスポンス

REST APIとのすべての通信は、要求と応答の間に挟まれています。 一方のシステムは、もう一方のシステムが応答する要求を行います。 WordPress REST APIには、プラグインがWordPress REST APIを拡張するときにリクエストデータ(WP_REST_Request)にアクセスし、レスポンスデータ(WP_REST_Response)を管理するための便利なオブジェクトが含まれています。

WordPressにRESTAPIをインストールする方法

WordPressバージョン4.7の時点で、WordPressにはコア機能としてRESTAPIが含まれています。

古いバージョンを実行している場合は、json-rest-api機能プラグインをインストールできます。 これは、WordPressコードベースと完全に統合される前にRESTAPIを開発するために使用されました。 このプラグインは技術的に閉鎖されているため、代わりにWordPressのバージョンを更新することをお勧めします(または、マネージドWordPressホスティングを検討すると、常に最新の状態になります)。

WordPressRESTAPIの例

GiveWPのWebサイトをご覧ください。 彼らのブログに行くと、最近のニュースや投稿を見ることができます。 このルートはHTMLをレンダリングします。これは見た目は良いですが、プログラマーが対話するのは困難です。 代わりに、「/ wp-json / wp / v2/posts」ルートを使用してプログラマーが投稿を利用できるようになります。

「/wp-json/ wp / v2 / posts」ルートは、これがWordPressリソース(「/ wp」)であり、これがリソースのバージョン2(「/ v2 /」)であり、具体的にはこれらが投稿(「/ posts」)。 まだ行っていない場合は、https://givewp.com/wp-json/wp/v2/postsにアクセスし、表示されている内容をhttps://givewp.com/blog/と比較してください。 ヒントをお伝えします—それは同じ情報です!

WordPress内でRESTAPIがどのように使用されるかの例については、最新の投稿ブロックを検討してください。 WordPressで投稿のリストを取得するには、従来、サイトはサーバーにリクエストを送信してから、ページ全体を再レンダリングする必要がありました。

最新の投稿ブロックは、投稿のみを要求してから、それ自体を再レンダリングできます。 これは、RESTAPIを使用して行われます。 また、ページ全体を再レンダリングすることなく、新しい投稿をポーリングするために複数回実行できます。 これは、ブロックを使用してページのコンポーネントを編集および表示するフルサイト編集を検討する場合に特に便利です。

個々のコンポーネントは、必要なデータ(更新の確認を含む)を要求し、変更されたものだけを再レンダリングできます。

今あなたは知っています

WordPress REST APIの目的と構造がわかったので、自分で何を見つけることができるかを見てみましょう。 WordPress REST APIの使用と拡張の詳細については、RESTAPIハンドブックをご覧ください。

覚えておいてください:誰かがAPIについてあなたに尋ねた場合、ワッフルハウスでパンケーキを注文することはできません。

サイトを微調整している間、優れたサイトには優れたホスティングが必要であることを忘れないでください。 NexcessのManagedWordPressですべてを手に入れることができます。 強力な速度、スケーラビリティオプション、および卓越したサポートにより、Nexcessを利用してWordPressサイトを強化できます。

Nexcessに優れた機能が組み込まれている理由をご覧ください。 今日、WordPressのフルマネージドホスティングプランをチェックしてください。

WordPressホスティングプランを探る

関連するWordPressリソース

  • WordPress.comとWordPress.org
  • WordPressサイトをスピードアップするための5つの高度なテクニック
  • WordPressホスティングとは何ですか?
  • WordPressプラグインのエッセンシャルガイド
  • Webホストを選択する方法:何を探すべきか、何を避けるべきか