api response
v1.2.2
CoreJsonResponse Характеристика ответа JSON. Эта особенность позволяет любому контроллеру легко возвращать ответ JSON с соответствующим кодом состояния HTTP.
composer require aelnemr/api-response
Все, что вам нужно, это use
особенность CoreJsonResponse
внутри вашего контроллера.
Пример:
<?php
namespace App Http Controllers ;
use Illuminate Http Request ;
use AElnemr RestFullResponse CoreJsonResponse ;
class CountryController extends Controller
{
use CoreJsonResponse;
public function index ()
{
$ data = App User:: get ();
return $ this -> ok ( $ data );
}
}
Метод | Код состояния | Описание |
---|---|---|
хорошо | 200 | Успешное получение, исправление (возврат объекта JSON) |
okWithPagination | 200 | Успешное получение, исправление (возврат объекта JSON) |
созданный | 201 | Успешная публикация (возврат объекта JSON) |
Метод | Код состояния | Описание |
---|---|---|
неаутентифицированный | 401 | Ошибка Не аутентифицирован |
запрещенный | 403 | Ошибка «Не авторизован» (пройдена проверка, но нет разрешений) |
не найдено | 404 | Ошибка не найдена |
недействительный запрос | 422 | Проверка ошибок |
Метод | Код состояния | Описание |
---|---|---|
принял | 202 | Успешная публикация, удаление, путь — асинхронный |
плохой запрос | 400 | Ошибка. Сервер не смог понять запрос из-за неправильного синтаксиса. |
оплатаОбязательно | 402 | Ошибка Требуется оплата |
конфликт | 409 | Ошибка Логическая ошибка |