Laravel API JSON Request change property names

Question

Is there any solutions on how to change property names or attributes of JSON Request in Laravel?

Something like Eloquent API Resources but instead in responses, it will be done in requests before directing to the request validation?

From this,

{
    "agent_reference": "ABC-12345",
    "product_instance_id": "aca68c65-44c3-4ea1-a726-ca183de09a31",
    "add_ons": [
        "string"
    ],
    "transportation": "string",
    "guests": [
        {
        "guest_type_key": "string",
        "add_ons": [
            "string"
        ],
        "field_responses": [
            {
            "key": "string",
            "response": "string"
            }
        ]
        }
    ]
}

To this,

{
    "agent_id": "ABC-12345",
    "plan_id": "aca68c65-44c3-4ea1-a726-ca183de09a31",
    "additional_params": [
        "string"
    ],
    "pickup_place": "string",
    "visitors": [
        {
        "visitor_kty": "string",
        "additional_params": [
            "string"
        ],
        "responses": [
            {
            "id": "string",
            "result": "string"
            }
        ]
        }
    ]
}

Welder Lourenço · Accepted Answer · 2019-08-02 04:23:10Z

1

Laravel 4 had support for such a thing, however, sadly, it got removed with the release of Laravel 5.

For Laravel 5.2+, the "neat" way of achieving this is is by overriding the validationData() method in your App\Http\Requests\FormRequest class.

Take a look at:

Illuminate\Foundation\Http\FormRequest

protected function validationData()
{
    return $this->all();
}

The function above is meant to return all inputs that will be sent to the validation, $this is the Request itself.

So, in your App\Http\Requests\FormRequest class, you define the very same method, get the inputs, sanitize as you want (even creating a whole new structure with different key names, as requested in your question), replace it in the request to persist and return, like so:

/**
 * Get data to be validated from the request.
 *
 * @return array
 */
protected function validationData()
{
    $inputs = $this->all();

    // Sanitize $inputs as your likes.

    $this->replace($inputs); // To persist.

    return $this->all();
}

This is how you get it done in Laravel 5.2+.

Hope it helps.

answered Aug 2, 2019 at 4:23

Welder Lourenço

1,05510 silver badges12 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Bricx Carasco Over a year ago

Thanks for this sir but the thing is how can i change those property names especially nested arrays attributes in order to pass in this validationData function?

Welder Lourenço Over a year ago

There's no out of the box way to achieve this with Laravel, you'll have to tackle it with pure php.

Bricx Carasco Over a year ago

Thank you very much for this answer sir. God bless.

Collectives™ on Stack Overflow

Laravel API JSON Request change property names

1 Answer 1

Illuminate\Foundation\Http\FormRequest

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Illuminate\Foundation\Http\FormRequest

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related