REST APIの命名規則

は、私は以下のような構文を実行しているいくつかのAPIのに気づいた。私の目にはREST APIの命名規則

/webapi/messaging/getMessage?messageID=n (HTTP GET)

いくつかの同僚は反対しているように見えるカントーこれは、悪い習慣です。私の目では、これは行に沿ったものでなければなりません

/webapi/messaging/messages/n (HTTP GET)

私は初心者です、これらの例はどちらも十分ですか？ 1つが良い場合は、なぜそれは良いですか？私の推論は、学んでいる間に私が拾ったものから来ています。それは悪い情報でもありません。

ありがとうございました

出典

2017-04-03 symon

あなたの方法は、それがより一般的に使用される規則に従ってという理由だけで、良いです。 –

未知のことを説明する方が良いと言ってもいいですか？たとえば、このシナリオでは、コンベンションBでメッセージを削除する方法がない場合、/ webapi/messaging/message/nの同じディレクトリにHTTP DELETEを追加するだけです。もう1つのシナリオでは、このシナリオであまり意味をなさないか、deleteMessageを必要としないでしょうか？id = n – symon

本当に問題ではありません。 RESTでは、通常のWebページのリンクなどのリンクを介してURLを検出できる必要があることを示しています。

ただし、一貫性のある、わかりやすいURL構造を使用すると、常により良い選択肢になります。したがって、REST APIの命名規則を使用する方がよいでしょう。

/webapi/messaging/message/n (HTTP GET)

Reference

出典

2017-04-03 11:34:24

答えて

関連する問題