api response

CoreJsonResponse

Característica de resposta JSON CoreJsonResponse. Essa característica facilita para qualquer controlador retornar uma resposta JSON com o código de status HTTP apropriado.

Instalar via compositor

 composer require aelnemr/api-response

Uso

Tudo o que você precisa é use a característica CoreJsonResponse dentro do seu controlador.

Exemplo:

 <?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 );
    }
}

Métodos disponíveis

Métodos de sucesso ✌️

Método	Código de status	Descrição
OK	200	Obtenção e correção bem-sucedidas (retornar um objeto JSON)
okWithPagination	200	Obtenção e correção bem-sucedidas (retornar um objeto JSON)
criado	201	Postagem bem-sucedida (retornar um objeto JSON)

Estado de erro?

Método	Código de status	Descrição
não autenticado	401	Erro Não autenticado
proibido	403	Erro Não autorizado (autenticado, mas sem permissões)
não encontrado	404	Erro não encontrado
solicitação inválida	422	Validação de erro

Métodos extras?

Método	Código de status	Descrição
aceito	202	Postagem bem-sucedida, exclusão, caminho - assíncrono
pedido ruim	400	Erro A solicitação não pôde ser compreendida pelo servidor devido a sintaxe malformada
pagamentoObrigatório	402	Erro Pagamento necessário
conflito	409	Erro Erro lógico