0

リクエスト/レスポンスに JSON を使用する API を構築しています。一括リクエスト、つまり JSON 配列も受信できるようにしたいと考えています。

現在、JSON リクエストが常に配列でラップされている場合に問題なく動作するソリューションがあります。

[
{"id":"AAAEEF", "value":"abc"}
]

また、動作します

[
{"id":"AAAEEF", "value":"abc"},
{"id":"AAAEF1", "value":"vbc"},
]

ID と値の組み合わせを 1 つだけ要求したい場合、

{"id":"AAAEEF", "value":"abc"}

リクエストは失敗します。

私の質問: 要素が 1 つしかない場合でも、すべての JSON リクエストを配列にラップすることを強制する「良い」API は受け入れられますか?

助けてくれてありがとう！

4

1 に答える 1

0

「優れた」API を作成するための鍵は、一貫性を保つことと、それを適切に文書化することです。次にどのような選択をするかはあなた次第です。API へのすべての呼び出しを thisIsAContainerObject 要素でラップする必要があると判断した場合は、必ず文書化してリリースしてください。

一貫性を保つために、常に配列を要求する方が明示的に優れている場合もあります。複数の要素が挿入されたときに適切なエラーをスローする限り。

于 2013-04-15T17:04:51.810 に答える