 |
JSON-WSPは、サービス記述、リクエスト、レスポンスにJSONを使用するWebサービスプロトコルです。 [ 1 ]
概要
これはJSON-RPCからインスピレーションを得ていますが、JSON-RPC にはドキュメント付きのサービス記述仕様がなかったため、JSON-WSP の設計が始まりました。
JSON-WSPにおける記述形式の目的は、SOAPにおけるWebサービス記述言語（WSDL）やCommon Object Request Broker Architecture （CORBA）におけるインターフェース記述言語（IDL）と同じであり、特定のサービスで使用される型とメソッドを記述することです。また、型間の関係（つまり、ネストされた型）も記述し、メソッドの引数として想定される型と、メソッドの戻り値としてユーザーが受け取ることが想定される型を定義します。さらに、この記述形式により、サービス、メソッド、パラメータ、戻り値のレベルに関するドキュメントを追加できるようになります。
クライアントとJSON-WSPサーバー間の通信は、 HTTP POST [ 2 ]リクエストとレスポンスを使用して実行され、JSONオブジェクトはコンテンツタイプapplication/jsonのデータとして使用されます。[ 3 ]
仕様
JSON-WSP は、次の 4 つの JSON オブジェクト仕様で構成されます。
| 仕様 | 説明 |
|---|---|
| 説明 | サービス記述仕様（WSDLに類似）。この仕様は、メソッド、メソッドパラメータ、型、戻り値の型を記述します。また、サービス、メソッド、パラメータの各レベルにおけるユーザードキュメントもサポートします。 |
| リクエスト | JSONリクエストの仕様。呼び出されるメソッドと、そのメソッド呼び出しに必要なすべての引数に関する情報が含まれます。リクエスト内の引数は、対応するJSON-WSP記述に記載されている同じメソッドのパラメータ定義に従う必要があります。 |
| 応答 | JSONレスポンスの仕様。レスポンスオブジェクトには、サービスメソッド呼び出しの結果が含まれます。戻り値の型は、対応するJSON-WSP記述内の同じメソッドの定義された戻り値の型に従う必要があります。 |
| 故障 | JSON障害レスポンスの仕様。障害オブジェクトには、障害コードと障害文字列が含まれます。障害情報は、障害がクライアント側で発生したかサーバー側で発生したかを示します。サーバー側のサービスフレームワークによっては、障害が発生したファイル名や行番号など、より詳細な情報を抽出できます。 |
参考文献
- ^ 「ECMAScript – 2017 言語仕様」(PDF) . Ecma-international.org . 2015年4月12日時点のオリジナル(PDF)からアーカイブ。 2018年1月28日閲覧。
- ^ Roy, Fielding; Julian, Reschke (2014). Fielding, R; Reschke, J (編). 「Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content」 . Tools.ietf.org . doi : 10.17487/RFC7231 . S2CID 14399078. 2018年1月28日閲覧。
- ^ "RFC 4627" . 2011年7月17日時点のオリジナルよりアーカイブ。2011年2月14日閲覧。
