Лучше ли размещать данные JSON или просто пары ключ-значение в Laravel Apis?

Question

Я разработал API в Laravel, теперь один из членов моей команды сказал, что я буду публиковать данные в формате Json во время вызова API. что мне теперь делать?

лучше ли размещать данные в формате Json или просто использовать пары ключ-значение? пожалуйста помогите

Answer 1

Я бы порекомендовал использовать ресурсы Laravel

Из документов:

    class User extends JsonResource
    {
        /**
        * Transform the resource into an array.
        *
        * @param  \Illuminate\Http\Request
        * @return array
        */
        public function toArray($request)
        {
            return [
               'id' => $this->id,
               'name' => $this->name,
               'email' => $this->email,
               'created_at' => $this->created_at,
               'updated_at' => $this->updated_at,
           ];
        }
    }

Если вы хотите вернуть один объект

Route::get('/user', function () {
    return new UserResource(User::find(1));
});

Если вы хотите вернуть коллекцию

Route::get('/user', function () {
    return UserResource::collection(User::all());
});

Таким образом, вы можете контролировать то, что возвращается по маршруту, и по умолчанию это будет json

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

Answer 2

«Лучше» очень субъективно. Ничто не подходит для КАЖДОГО варианта использования (особенно если речь идет об унаследованном коде), но обычно данные в API передаются с использованием JSON (в большинстве REST API) или XML (используется в SOAP). Вот некоторые вещи, которые следует учитывать: 1) REST независим от того, что ему безразлично, какой формат вы используете для своих данных, поэтому есть приложения, которые передают данные в формате csv, JSON, XML или что-либо еще, что вы можете себе представить.

2) Я считаю, что наиболее распространенная вещь, которую можно увидеть из настоящего безголового API - это JSON.

3) Как уже упоминалось ранее, JSON хорошо работает с другими языками, которые часто используются для использования API. В большинстве случаев, если я использую API, он написан на Javascript, Java или Python, и все они очень «дружественны к JSON». Это было бы моим предпочтительным форматом по этой причине.

4) Подумайте, что будет потреблять ваш API сейчас и в будущем, и постройте его так, чтобы он работал как можно лучше и «в будущем».

5) Кто-то еще должен будет прочитать ваш код позже. Использование четко определенного, хорошо документированного формата будет намного проще, чем расшифровка какого-либо метода, который вам необходим для анализа данных в строках или для работы с массивами каким-либо настраиваемым способом. тот.

6) Ответ Laravel () -> json () уже доступен с вашего контроллера. Это плюс родные JSON-методы JS, похоже, они должны были идти вместе.

Это только мой взгляд.

Answer 3

Json очень прост в обращении и доступен как для php, так и для JavaScript. Парсинг данных вашего сайта в json открывает широкие возможности, которые в противном случае будут затруднены. если вы используете laravel, вы можете использовать функции json_encode и json_decode () для разбора данных туда-сюда или вспомогательный класс JSON