未知のパラメーターを許容する必要がありますか？

私はRESTful APIを設計していますが、タイトルの問題に直面しました。

クライアントが認識されないパラメーターを送信した場合、高速で失敗する必要がありますか？例えば、

http://example.com/api/foo?bar=true&paula=bean

上記でbarは、は有効なパラメーターですがpaula、APIによって指定されていません。したほうがいい

• クライアントにエラーを警告する
• 早く失敗する
• それを無視します

クライアントに警告する場合、最初のパラメーターに対して警告を発行できるのは、ほぼ無限の数のパラメーターを送信している可能性があり、サーバーにはおそらくより良いことがあるからです。同様に、失敗すると、最初の無効なパラメータのみが問題として指定されます。

警告を出すよりもプログラマーに強制的に行動を起こさせるよりも失敗を好む。そうでなければプログラマーは問題を無視してリソースを浪費し続けるかもしれない。その点で何もしないのはさらに悪いことです。

私の議論は理にかなっていますか？そのようなことに関して受け入れられている慣行はありますか？

私の意見では、Invalid Requestステータスを返すべきです。そうすれば、クライアントがやろうとしていることが無効であることがクライアントにわかります。これに関する私の意見は、RESTful APIが発見可能でれます。前もって十分な情報を提供している場合、クライアントは最初から無効な要求をしようとしません。存在する場合、クライアントコードに何らかの問題があり、高速で失敗すると、2番目にこのバグが警告されます。もちろん、これは非常に純粋なアプローチであり、APIが発見できない場合はお勧めできません。

より実用的なアプローチは、無効なパラメータを無視することかもしれませんが、どちらにしても、動作をよく文書化してください。

パブリックAPI（または他のチームが使用するAPI）を実行する場合は、@ RubberDuckが示唆したようにエラーを返すことをお勧めします。

APIがチーム内でのみ（または自分でのみ）消費される場合、余分なフィールドを無視する方が簡単な場合があります（たとえば、必要なコードが少なくて済み、実行が容易です）。