目次
CouchbaseのREST APIは、Couchbase Serverの配備を管理するだけでなく、デザインドキュメントを格納し、その結果を照会するなどの操作を実行できます。REST APIは、Representational State Transfer（REST）の制約に準拠しており、換言すれば、REST APIは、RESTfulアーキテクチャに準拠しています。クラスタ、サーバノード、およびバケットを管理するためや、Couchbase Serverの配備内で実行時の統計情報を取得するために、REST APIを使用します。Couchbase互換SDKを開発したい場合にも、ビューを処理するためのライブラリー内でREST APIを使用します。ビューを使用すると、定義した関数をもとにインデックスや、データの照会をすることができます。ビューの詳細については、9章ビューとインデックス を参照してください。
REST APIはサーバへのデータ読み書きに利用するべきではありません。
たとえば、setやgetなどのデータ操作はCouchbase SDKによって処理します。
Couchbase SDKを参照してください。
REST APIは、Couchbase Serverの製品内の様々なシステムにアクセスします。
RESTfulなリクエストを指定してください。処理命令やリソース記述を取得しなくてもよく、また表示されるリソースのURI構造の規則を推測する必要もありません。REST APIのURIは特定のURIとなりますが、HTTP操作とセマンティクスを使用した、RPCやその他のアーキテクチャ様式となることもあります。
言い換えると、CouchbaseクラスタURIから始まるリクエストを構築すべきで、リソースのURIはバージョンごとに変更される可能性があることに注意する必要があります。また、同様のパターンでシステムの様々な部分にアクセスするので、ここで表された階層により、リクエストの再利用が可能となることにも注意してください。
REST APIは、多くの基本理念の上に構築されています：
JSON レスポンス
Couchbase管理REST APIは、JavaScript Object Notation（JSON）形式で多くの応答を返します。ノード上でJSONリーダを使用して応答を読み取ると便利でしょう。応答が空の場合もありますが、標準のHTTPコードを返します。詳細については、RFC 4627（http://www.ietf.org/rfc/rfc4627.txt）およびwww.json.orgを参照してください。
HTTP ベーシックアクセス認証
Couchbase管理REST APIは、HTTPベーシック認証を使用しています。ブラウザベースの6章Webコンソールの利用と7章管理用コマンドラインインターフェイスもまた、HTTPベーシック認証を使用しています。
汎用性の高いサーバノード
クラスタ内のすべてのサーバノードは同じプロパティを共有し、REST APIを介して行われたリクエストを処理することができます。サーバノードがリクエストを直接処理できない場合、ステータスや他の情報へのアクセスができないので、適切なサーバー・ノードにリクエストを転送し、結果を取得して、クライアントに結果を送り返します。
REST APIを使用するためには、次のセクションで説明されている様々な用語や概念を知っておく必要があります。