名前空間とバージョン

このテキストはAIを使用して翻訳されました。英語の原文を表示するには、こちらをクリックしてください。

WordPress.com REST API は3つの異なる名前空間に整理されており、それぞれが特定の目的を持ち、独立したバージョニングスキームに従っています。これらの名前空間を理解することは、インテグレーションに適したエンドポイントを選択し、WordPress.com とセルフホスト型の WordPress サイトの両方との互換性を確保するために不可欠です。

API 名前空間の概要

WordPress.com REST API は3つの主要な名前空間を提供しており、それぞれ異なるユースケースと互換性レベルを対象としています。

名前空間	利用可能なバージョン	主な目的	WordPress コア互換
/rest/	v1, v1.1, v1.2, v1.3, v1.4	レガシーな WordPress.com 管理およびプラットフォーム機能	いいえ
/wp/	v2	公式 REST API 仕様に準拠した標準的な WordPress コアリソース	はい
/wpcom/	v2, v3, v4	最新の WordPress.com 固有の機能とサービス	いいえ

/rest/ 名前空間 – レガシー WordPress.com API

/rest/ 名前空間は、WordPress コア REST API よりも前に存在していたオリジナルの WordPress.com REST API を表しています。WordPress.com プラットフォームの機能やサイト管理機能への包括的なアクセスを提供します。

利用可能なバージョン： v1, v1.1, v1.2, v1.3, v1.4（API コンソールの WP.COM API オプションからアクセス）

ベース URL：

• https://public-api.wordpress.com/rest/v1/
• https://public-api.wordpress.com/rest/v1.1/
• https://public-api.wordpress.com/rest/v1.2/
• https://public-api.wordpress.com/rest/v1.3/
• https://public-api.wordpress.com/rest/v1.4/

主な機能:

• 包括的なサイトおよびユーザー管理
• 統計情報、Reader、通知などの WordPress.com 固有の機能
• 高度なサイト設定とドメイン管理
• Jetpack 統合機能

バージョニング戦略: 各バージョン（v1.1〜v1.4）では、後方互換性を維持しながら、段階的な改善、新しいエンドポイント、機能の強化が導入されました。複数のバージョンにまたがるエンドポイントでは、新しいバージョンほど追加フィールド、パフォーマンスの向上、またはバグ修正が提供されます。

最適な用途:

• 他では利用できない WordPress.com 固有の機能へのアクセス
• 高度なサイト管理と設定
• 既存のインテグレーションとの互換性の維持
• 詳細な統計情報、Reader 機能、ドメイン管理などの機能

エンドポイントの例:

• /rest/v1.4/sites/{site}/posts
• /rest/v1.4/sites/{site}/stats
• /rest/v1.4/me/sites
• /rest/v1.3/read/following

/wp/ 名前空間 – WordPress コア REST API

/wp/ 名前空間は、WordPress REST API の公式仕様を実装しており、WordPress.com とセルフホスト型 WordPress サイトの両方との完全な互換性を保証します。この名前空間は、WordPress コアチームが策定した標準に準拠しています。

利用可能なバージョン: v2（API コンソールの WP REST API オプションからアクセス）

ベース URL: https://public-api.wordpress.com/wp/v2/

主な機能:

• 標準的な WordPress リソース（投稿、固定ページ、コメント、タクソノミー、ユーザー、メディア）
• セルフホスト型 WordPress サイトとの完全な互換性
• WordPress コア標準に準拠した一貫性のあるエンドポイント構造
• セルフホスト型サイトではプラグインによる拡張が可能

設計思想: この名前空間は、WordPress.com 固有の機能よりも標準化と互換性を優先しています。あらゆる WordPress インストールで利用可能な REST API と同等の構造を持つため、異なる WordPress 環境間で動作する必要があるアプリケーションに最適です。

最適な用途:

• WordPress コア機能を必要とする新規プロジェクト
• WordPress.com とセルフホスト型サイトの両方で動作する必要があるアプリケーション
• 標準的なコンテンツ管理（投稿、固定ページ、メディア、ユーザー）
• 既存の WordPress ツールやプラグインとの統合

エンドポイントの例:

• /wp/v2/posts
• /wp/v2/pages
• /wp/v2/users
• /wp/v2/media
• /wp/v2/sites/{site}/posts

/wpcom/ 名前空間 – モダンな WordPress.com プラットフォーム API

/wpcom/ 名前空間は、WordPress.com 固有の API 機能の進化形であり、モダンなデザインパターンや WordPress コアでは利用できない高度なプラットフォーム機能を備えています。

利用可能なバージョン: v2、v3、v4（API コンソールの WP REST API オプションからアクセス）

ベース URL:

• https://public-api.wordpress.com/wpcom/v2/
• https://public-api.wordpress.com/wpcom/v3/
• https://public-api.wordpress.com/wpcom/v4/

主な特徴:

• 構造とパフォーマンスが改善されたモダンなデザインの API
• 高度な WordPress.com サービス（Reader、拡張統計、通知）
• ユーザーエンゲージメント機能（フォロー、いいね、おすすめ）
• プラットフォーム固有の機能はセルフホスト型の WordPress では利用できません

バージョニング戦略: 各バージョンでは、新しい機能、セキュリティの改善、洗練されたデータ構造が導入されます。/rest/ 名前空間とは異なり、/wpcom/ はレガシー互換性ではなく、将来を見据えた機能に重点を置いています。

最適な用途:

• 最新の WordPress.com プラットフォーム機能
• ユーザーエンゲージメントおよびソーシャル機能
• 高度な分析とおすすめ
• 最新の WordPress.com 機能を必要とする新しいインテグレーション

エンドポイントの例:

• /wpcom/v4/me/follows
• /wpcom/v3/notifications
• /wpcom/v2/read/tags
• /wpcom/v4/sites/{site}/stats/insights

適切な名前空間の選択

名前空間の選択は、具体的な要件と互換性のニーズによって異なります。

以下のような標準的な WordPress 機能が必要な場合は /wp/v2/ を使用してください：

• WordPress のコア機能（投稿、固定ページ、ユーザー、メディア）
• セルフホスト型 WordPress サイトとの互換性
• 標準的な REST API のパターンと構造
• 既存の WordPress ツールやプラグインとの統合

以下のような WordPress.com プラットフォーム機能が必要な場合は /wpcom/v4/（または利用可能な最新バージョン）を使用してください：

• WordPress.com の高度なサービスとソーシャル機能
• モダンな API 設計とパフォーマンスの向上
• 最新のプラットフォーム機能と統合
• WordPress.com エコシステム固有の機能

以下のようなレガシー機能と互換性が必要な場合は /rest/v1.4/（または必要なバージョン）を使用してください：

• レガシーエンドポイントでのみ利用可能な特定の機能
• 既存の統合との後方互換性
• 新しい名前空間にまだ移行されていない高度なサイト管理機能
• 包括的な統計情報とアナリティクス機能

バージョン選択のガイドライン

各名前空間内でのバージョン選択は、以下の原則に従います。

複数のバージョンが利用可能な場合：エンドポイントが複数のバージョンにまたがって存在する場合、新しいバージョンでは通常以下が提供されます。

• 追加のレスポンスフィールドとパラメータ
• パフォーマンスと信頼性の向上
• バグ修正とセキュリティの強化
• 後方互換性を維持しながらの機能拡張

推奨されるアプローチ：以下の場合を除き、常に利用可能な最新バージョンを使用してください。

• インテグレーションが古いバージョンの特定の動作に依存している場合
• 特定の API レスポンスを必要とするレガシーコードを保守している場合
• 互換性の要件により特定のバージョンが必要な場合

API コンソールの構成を理解する

WordPress.com API コンソールでは、名前空間が2つの主要カテゴリに整理されています。

• WP.COM API：すべての /rest/ 名前空間バージョン（v1〜v1.4）が含まれます
• WP REST API：/wp/v2/ およびすべての /wpcom/ 名前空間バージョン（v2〜v4）が含まれます

この構成は、WordPress.com 固有の API から、標準化された WordPress コア API およびモダンなプラットフォーム機能への進化を反映しています。

移行に関する考慮事項

インテグレーションを計画する場合や、既存のインテグレーションを更新する場合:

新規プロジェクト: コア機能には /wp/v2/ を、プラットフォーム固有の機能には /wpcom/v4/ を使用してください。

既存のインテグレーション: 以下の場合、/rest/ エンドポイントから新しい名前空間への移行を検討してください:

• 同等の機能が /wp/v2/ または /wpcom/ に存在する場合
• パフォーマンスの向上や追加機能が必要な場合
• 長期的なメンテナンスとサポートが優先事項である場合

機能の利用可否: 一部の高度な機能は /rest/ 名前空間でのみ利用可能です。移行前に機能要件を評価し、必要なすべての機能がターゲットの名前空間で利用できることを確認してください。