JSON formatting in Laravel

Question

Lets say I have three models and tables i.e. Schools, Class and students. The School and Class are in one to many relation and Class and students are also in one to many relationship. Now I am creating a RESTFUL API to send all these data at once in this JSON format:

[{
        "1": {
            "school_id": 1,
            "school_name": "Havard",
            "Class": {
                "1": {
                    "class_id": 1,
                    "school_id": 1,
                    "class": "6",
                    "Student": {
                        "1": {
                            "Student_fname": "SomeName",
                            "Student_lname": "Last Name"
                        },
                        "2": {
                            "Student_fname": "Another",
                            "Student_lname": "AnotherLast"
                        }
                    },
                    "2": {
                        "class_id": 2,
                        "school_id": 28,
                        "class": "7",
                        "Student": {
                            "1": {
                                "Student_fname": "Anotherone",
                                "Student_lname": "Last"
                            },
                            "2": {
                                "Student_fname": "New",
                                "Student_lname": "Newer"
                            }
                        }
                    }
                }
            }
        }

    },
    {
        "2": {
            "school_id": 1,
            "school_name": "AnotherSchool",
            "Class": {
                "1": {
                    "class_id": 1,
                    "school_id": 1,
                    "class": "6",
                    "Student": {
                        "1": {
                            "Student_fname": "SomeName",
                            "Student_lname": "Last Name"
                        },
                        "2": {
                            "Student_fname": "Another",
                            "Student_lname": "AnotherLast"
                        }
                    },
                    "2": {
                        "class_id": 2,
                        "school_id": 28,
                        "class": "7",
                        "Student": {
                            "1": {
                                "Student_fname": "Anotherone",
                                "Student_lname": "Last"
                            },
                            "2": {
                                "Student_fname": "New",
                                "Student_lname": "Newer"
                            }
                        }
                    }
                }
            }
        }
    }
]

How do I achieve this format? Is my this json format correct? Is there a better way to achieve it?

i think class(if classes are more than one) and student should be array of object(json). — Ketan Akbari
– Ketan Akbari, Commented Mar 17, 2018 at 4:31
Yes classes are more than one in a school. Could you show an example of a code to make it clear? — Animesh Pandey
– Animesh Pandey, Commented Mar 17, 2018 at 7:33

Imran Zahoor · Accepted Answer · 2023-03-15 16:11:15Z

2

If like me, you want to format JSON string using Laravel collection please use the technique below:

$json = collect([
    'name' => 'Test',
    'description' => 'Another awesome laravel package',
    'license' => 'MIT'
  ])->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);

echo $json;

The output generated would have the below format:

{
    "name": "Test",
    "description": "Another awesome laravel package",
    "license": "MIT"
}

The same technique can be applied to results of eloquent query. And writing JSON to files to storage.

Reference link

answered Mar 15, 2023 at 16:11

Imran Zahoor

2,8371 gold badge34 silver badges42 bronze badges

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

Comments

Mauran Muthiah · Accepted Answer · 2018-03-17 07:52:42Z

You can use a library like https://github.com/thephpleague/fractal, https://github.com/dingo/api or do it by making transformer methods in your controllers(or classes if you prefer)

Some pseudo code

<?php
class UserController extends Controller
{

    public function index(Request $request) {
        $users = Users::all(); 

        $response = []; 

        foreach ($users as $user) {
            $response[] = $this->transform($user); 
        }

    }

    public function transform(User $user) {
        return [
            'username' => $user->username,
            'age' => $user->age,
            'class' => [
                'name' => $user->school->name,
                'something' => $user->school->something
            ]
        ];
    }

}

I higly recommend doing the transform-part in other classes than in the controller itself.

Yassine Chettouch · Accepted Answer · 2022-12-12 03:02:22Z

1

For people visiting this question for a solution about JSON Formatting in Laravel, I recommend you use JSON formatter Extension on Chrome to test your API Responses instead of losing time for a simple task. It's just my personal recommendation, you can create or use a plugin to manage JSON responses on your code anyway.

answered Dec 12, 2022 at 3:02

Yassine Chettouch

4186 silver badges20 bronze badges

Comments

Aaron Adrian · Accepted Answer · 2018-03-17 07:54:44Z

0

Look into Laravel API Resources.

https://laravel.com/docs/5.6/eloquent-resources

answered Mar 17, 2018 at 7:54

Aaron Adrian

5293 silver badges13 bronze badges

Comments

pedrofernandes · Accepted Answer · 2025-03-05 18:39:36Z

0

This works for me

public function index() {
    $ocorrencies = Ocorrency::all();
    return response()->json($ocorrencies, 200, [], JSON_PRETTY_PRINT);
}

answered Mar 5 at 18:39

pedrofernandes

16.9k10 gold badges38 silver badges44 bronze badges

Comments

Ketan Akbari · Accepted Answer · 2018-03-19 05:10:58Z

-1

I think should be like this

[
"1": {
"school_id": 1,
    "school_name": "Havard",
    "Class": [
    "1": {
            "class_id": 1,
            "school_id": 1,
            "class": "6",
            "Student": [
                "1": {
                "Student_fname": "SomeName",
                    "Student_lname": "Last Name"
                }
            ]
         }
    ]
}
]

edited Mar 19, 2018 at 5:10

answered Mar 19, 2018 at 4:56

Ketan Akbari

11.3k5 gold badges36 silver badges52 bronze badges

Collectives™ on Stack Overflow

JSON formatting in Laravel

6 Answers 6

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related