共通ルール


リクエストヘッダー

{
    'Content-Type'  : 'application/json',
    'Accept'        : 'application/json'
    "Accept-Charset": "UTF-8",
    'Authorization' : 'Bearer {{api_token}}'
}

レスポンスの型

JSON


レスポンス成功時

成功時

ステータスコード:200

{
  "result"   : true, //成功時はtrue
  "errors"   : "",   //成功時は空
  "data" :     //データは必ずdataの中に
    {
      "id"       : 15,
      "name"     : "英語"
    },
}

レスポンス失敗時

失敗時

ステータスコード:200

基本500以外の時は200で返却する

{
  "result"   : false, //失敗時はfalse
  "errors"   : "",    //失敗時は指定したエラーメッセージをここに格納
  "response" :{      //失敗時は空
  }
}

{danger} ・レスポンス結果が0件などは失敗ではなく成功に
・ステータスコードはそれぞれ変動

下記Laravel標準エラーコード

code 名称
400 'bad_request'
401 'unauthorized'
403 'forbidden'
404 'not_found'
405 'method_not_allowed'
422 'validation_error'
500 'internal_server_error'