RESTfulなWEBアプリケーションを構築しています。
現在、クライアントサイド(HTML5 + JavaScript)から、サーバサイド(Java Spark Framework)のAPIをHTTPメソッドGETでキックする必要があり、その際の配列データの受け渡しで困っています。
通常Ajaxのdataパラメータを利用することと思いますが、下記のように配列を含めた場合、
GETパラメータはarray[]=hoge1&indexName[]=hoge2&indexName[]=hoge3
のようにキー名に[]
が
付与される形で渡されることになるかと思います。
var req = {"array": ["hoge1", "hoge2", "hoge3"]}
function() {
$.ajax({
url: xxxxxxxxxx,
type: "GET",
dataType: "json",
data: req
}).done(function(res) {
}).fail(function(res) {
});
一方で下記の記事のように、カンマ区切りの文字列で渡す方法もあるのかなと思います。
http://javatechnology.net/ajax/json-parameter-array/
var req = {"array": "hoge1, hoge2, hoge3"}
function() {
$.ajax({
url: xxxxxxxxxx,
type: "GET",
dataType: "json",
data: req
}).done(function(res) {
}).fail(function(res) {
});
いずれもサーバサイドのパース処理次第でどうにでもなるのかなと思いますが、
クエリパラメータの仕様として階層構造を持ったデータの渡し方が定められているのでしょうか?
クライアントもサーバもオレオレ仕様でやり取りしているだけでしょうか?
RESTFulなAPIを設計した場合、このようにGETで階層構造を持つデータをやり取りする際に、
煩雑だなと感じています。(全てPOSTもありなのではないかと。)
これは蛇足ですが、もしご存知でしたら
サーバサイド(Java)のクエリパラメータのパース処理ライブラリがあればご教示ください。
-
気になる質問をクリップする
クリップした質問は、後からいつでもマイページで確認できます。
またクリップした質問に回答があった際、通知やメールを受け取ることができます。
クリップを取り消します
-
良い質問の評価を上げる
以下のような質問は評価を上げましょう
- 質問内容が明確
- 自分も答えを知りたい
- 質問者以外のユーザにも役立つ
評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。
質問の評価を上げたことを取り消します
-
評価を下げられる数の上限に達しました
評価を下げることができません
- 1日5回まで評価を下げられます
- 1日に1ユーザに対して2回まで評価を下げられます
質問の評価を下げる
teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。
- プログラミングに関係のない質問
- やってほしいことだけを記載した丸投げの質問
- 問題・課題が含まれていない質問
- 意図的に内容が抹消された質問
- 過去に投稿した質問と同じ内容の質問
- 広告と受け取られるような投稿
評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。
質問の評価を下げたことを取り消します
この機能は開放されていません
評価を下げる条件を満たしてません
質問の評価を下げる機能の利用条件
この機能を利用するためには、以下の事項を行う必要があります。
- 質問回答など一定の行動
-
メールアドレスの認証
メールアドレスの認証
-
質問評価に関するヘルプページの閲覧
質問評価に関するヘルプページの閲覧
checkベストアンサー
+2
この手は、API 実装でのインターフェイスに関する決め事の話ですね。厳密な RESTful の思想を貫く学問としてシステムを構築しているのであれば以下は参考にならないでしょう。ビジネスでゴールを取るのであれば以下の方法が1つの解決策になると思います。
私が過去作ったシステムでは、JavaScript 側が扱っている構造を持つ情報をサーバに渡して、それに応じた結果を JavaScript で反映させる。という流れの情報を得る API の整備が幾つか必要だった事がありますが、JavaScript からは共通的なパラメータとは別に、オブジェクト自体を JSON 形式で POST して、サーバサイドが Java であれば JSONIC などパース用のライブラリを使って解釈させ、結果も JSON で返却しましたね。これを Ajax で都度呼び出す様な処理を行ってブラウザ上の表示内容を更新させました。
GET でも、データをシリアライズなり一手間加えれば渡せるでしょうし、RESTful の万能な解決策がもしあるならば、それに従うべきでしょうが、配列なりの構造を持つを情報を取り扱う機能をユーザが直接 URL を叩いて GET でアクセスするような状況は考えにくいので RESTful にこだわって設計や実装が滞るのは違うと考えてしまいます。あと、POST を使ったのは GET の QueryString では HTTPS の暗号化の対象外になるため(パラメータの用途にもよるでしょうが)セキュリティ的な面を考えて使えなかった。というのもあります。
実装上、JavaScript で渡しやすい形式、書きやすいコードとなると、JSON を使うのが良い落とし所なのではないでしょうか?
データを渡す外枠となるコンテナの仕様を JSON なりの整った形に固定できれば、結果としてその後の修正や拡張で影響を受ける箇所は、個別の実装だけになるため、大枠の構造を固めてしまうのは有効な手です。似た系統の API が幾つか存在するのであれば、後々の事を考えて、サーバ、クライアント共にある程度処理を揃えておくのが良いでしょう。
以上、ご参考になれば幸いです。
投稿
-
回答の評価を上げる
以下のような回答は評価を上げましょう
- 正しい回答
- わかりやすい回答
- ためになる回答
評価が高い回答ほどページの上位に表示されます。
-
回答の評価を下げる
下記のような回答は推奨されていません。
- 間違っている回答
- 質問の回答になっていない投稿
- スパムや攻撃的な表現を用いた投稿
評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。
15分調べてもわからないことは、teratailで質問しよう!
- ただいまの回答率 88.36%
- 質問をまとめることで、思考を整理して素早く解決
- テンプレート機能で、簡単に質問をまとめられる