spohess / api-response
Pacote de formatação de response
v1.1
2020-04-04 21:01 UTC
Requires
- php: >=5.4.0
This package is auto-updated.
Last update: 2024-03-05 05:54:49 UTC
README
v1.0.1
Pacote e padronização de response de API
{
success: true,
statusCode: 200,
message: Requisição processada,
data: []
}
Descrição
- success: (Boolean)
- Indicador se a requisição efetuada foi processada com sucesso ou não;
- Padrão: true;
- statusCode: (Integer)
- Código de status HTTP (seguindo a seguinte regra: List of HTTP status codes);
- Padrão: 200;
- message: (String)
- Mensagem descritiva do processamento efetuado;
- Padrão: enviando dados;
- 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);
}