psychemedics/gerador-response

There is no license information available for the latest version (v2.0) of this package.

Repositório do pacote de padronização de response para APIs

v2.0 2018-11-10 19:02 UTC

README

versão 1.0

Esse pacote é destinado a padronização da formatação das responses das APIs da Psychemedics onde, a formatação, segue o padrão a seguir:

{
    success:true,
    statusCode:200,
    message:enviando dados,
    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 psychemedics/gerador-response

Exemplo

Laravel:

use GeradorResponse\PsyAPI;

public function getDados(Request $request)
{

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

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