spohess/api-response

Pacote de formatação de response

v1.0.1 2019-02-02 12:52 UTC

README

v1.0.1

Pacote e padronização de response de API

{
    success: true,
    statusCode: 200,
    message: Requisição processada,
    data: []
}

Descrição

  1. success: (Boolean)
  • Indicador se a requisição efetuada foi processada com sucesso ou não;
  • Padrão: true;
  1. statusCode: (Integer)
  1. message: (String)
  • Mensagem descritiva do processamento efetuado;
  • Padrão: enviando dados;
  1. data: (Array)
  • Informações solicitadas na requisição;
  • Campo obrigatório, mesmo que sendo um array vazio;

Instalação

composer require spohess/api-response

Exemplo

Laravel:

use ApiResponse\BasicoApiResponse;

public function getDados(Request $request)
{

    $retorno = BasicoApiResponse::gerar($request->all(), 'Retornando request', 200, true);

    return response()->json($retorno, 200);
}