Laravel Türkiye Discord Kanalı Forumda kod paylaşılırken dikkat edilmesi gerekenler!Birlikte proje geliştirmek ister misiniz?

Validator çıktısını özelleştirme

enessvg

Merhaba validation işleminde Requests kullanıyorum ve bunu controllerimde kullanıyorum.

İstediğim şey ise şu:
Bu çıktıyı:
{
"message": "Lütfen adınızı ve soyadınızı giriniz.",
"errors": {
"fullname": [
"Lütfen adınızı ve soyadınızı giriniz."
]
}
}

Buna çevirmek istiyorum:

{
"status": "error",
"message": "The name field is required.",
"data": null
}

böyle birşey mümkünmü?

mgsmus

enessvg Mümkün ama kullanıcı ya da istemci hangi alanda hata olduğunu nasıl anlayacak? Bazen buna göre işlem yapmak gerekebiliyor. Ayrıca API yanıtlarına status:"error" gibi durum ifadeleri eklenmez; uygun HTTP kodu ile dönüş yapılır, validation hatası için 422 gibi.

enessvg

mgsmus böyle bir talep olduğu için sormam gerekti o zaman bu saçma veyada yanlış birşey olduğunu söylüyorsunuz yani

mgsmus

enessvg Şöyle, mesajı olduğu halde bırakıp üstüne ekleme yapabilirsiniz. Mesela

{
  "message": "Email alanı gereklidir.",
  "errors": {
    "email": [
      "Email alanı gereklidir."
    ]
  },
  "rules": {
    "email": [
      "Required"
    ]
  }
}

Burada email hangi kuraldan dolayı hata vermiş bunu anlayabiliyorsunuz. Hata veren kurala göre gelen yanıta karşılık özel işlem yaptırabilirsiniz. Bu gayet mantıklı bir değişiklik.

status:"error" ise yanlış bir işlem. Bunun iki versiyonu var:

HTTP 422 kodu ile dönebilir, JSON içine gereksiz ekleme yapmış olursunuz. Dönen kod 2xx değilse zaten başarısız demektir; validation daima 422 döner, o zaman içeriye status eklemenin bir anlamı yok.
HTTP 200 kodu ile dönebilir. Bu çok yanlış. Mesela Laravel Http Client ile bir API'a istek attığınızı düşünün ve o da size HTTP 200 kodu ile status:"error" dönmüş olsun:

$response = Http::post($url, $payload)
    ->throw()
    ->json();

Burada bu kod throw() kullanılmış olsa bile exception fırlatmaz çünkü status kodu 200. O yüzden Http 2xx ile status:"error" çok yanlış. Nam-ı diğer:

enessvg

Hocam peki benden istenilen çıktıyı vermem için nereye ne kod yazmalıyım?

enessvg

@mgsmus

enessvg

sorunu çözdüm

sineld

enessvg nasıl?

mgsmus

sineld Laravel 11 için boostrap/app.php içinde

->withExceptions(function (Exceptions $exceptions) {
    $exceptions->render(function (ValidationException $e, Request $request) {
        if ($request->expectsJson()) {
            $names = array_map(function ($items) {
                return array_map(function ($key) {
                    if (str_contains($key, '\\')) {
                        $parts = explode('\\', $key);

                        return end($parts);
                    } else {
                        return $key;
                    }
                }, array_keys($items));
            }, $e->validator->failed());

            return response()->json([
                'message' => $e->getMessage(),
                'errors' => $e->errors(),
                'rules' => $names,
            ], $e->status);
        }

        return null;
    });
});

Laravel 8/9/10 için app/Exceptions/Handler.php içinde

protected function invalidJson($request, ValidationException $e)
{
    $names = array_map(function ($items) {
        return array_map(function ($key) {
            if (str_contains($key, '\\')) {
                $parts = explode('\\', $key);

                return end($parts);
            } else {
                return $key;
            }
        }, array_keys($items));
    }, $e->validator->failed());

    return response()->json([
        'message' => $e->getMessage(),
        'errors' => $e->errors(),
        'rules' => $names,
    ], $e->status);
}