2017-01-18 15 views
0

メンバーシップを検証する簡単なAPIを作成しています。クライアントはString IDを入力する必要があり、IDがコミュニティの有効なメンバーであるかどうかをチェックします。 IDは数字のみで、長さは10でなければなりません。REST HTTPステータスコード検証のベストプラクティスAPI

かなり簡単ですか?

IDが有効な場合はもちろん、HTTPステータスコードはOKです。 IDにアルファベットが含まれているか、または10を超えない場合は、HTTPステータスコードBAD REQUESTが返されます。

質問は、IDが数字で長さ= 10で、コミュニティのメンバーではない場合に最も有効なHTTPステータスコードは何ですか?なんで。

+0

これはベストプラクティスかどうかわかりませんが、すべての妥当性チェックが成功し、そのIDのレコードが見つからないため、HTTPステータスコードNOT_FOUND(404)が返されます。あなたのコミュニティで –

答えて

0

通常、REST APIのエンドポイントは、GET、PUT、POST、DELTEなどのHTTPメソッドを使用して動作するリソースです。このようにすると、どのHTTPステータスを返すかを決める方がずっと簡単です。

だから、このIDを持つメンバーがHTTP 200を返し、存在する場合は、あなたが基本的なメンバー情報

  • でいくつかのJSONをしたい場合は、idが有効である場合は、エンドポイント

    /member/{id} 
    
    • 作ることができるかもしれ、IDが有効でない場合
    • NOT FOUNDは、長さ= 10、または無効な文字が含まれているHTTP 400 BAD REQUESTを返す
    - !、ないメンバーがHTTP 404を返し、存在しません

    詳細はこちらREST API design

  • 関連する問題