8. HTTPメソッド
GET リソースの取得
POST リソースの作成
PUT リソースの状態変更や更新
DELETE リソースの削除
HEAD メタ情報の取得。
OPTIONS
URIで指定されたリソースでサポートされている
HTTP(API)のリストを応答
リソースに対する操作をHTTPメソッドで表す
23. エラーフォーマット
• エラー時は同じフォーマットで応答する。
• クライアントが自己解決できるように詳細情報を含める。
• システムの脆弱性をさらすような事象は詳細情報を含めない。
• フォーマット例
{
"code" : "e.ex.fw.7001",
"message" : "Validation error occurred on item in the request body.",
"details" : [ {
"code" : "ExistInCodeList",
"message" : ""genderCode" must exist in code list of CL_GENDER.",
"target" : "genderCode"
} ]
}
• detailsには、パラメータエラーに対する各項目の詳細エラーを設定。
24. HTTPメソッド
• リソースをどのように操作したいかを表す
GET リソースの取得
POST リソースの作成。URLを新規に生成する操作。
PUT
リソースの状態変更や更新。URLに対応するデータが
存在しない場合は生成、存在する場合は更新する。
DELETE リソースの削除
HEAD
メタ情報の取得。Getと同じ処理を行いヘッダ情報の
み取得。
OPTIONS
URIで指定されたリソースでサポートされている
HTTP(API)のリストを応答