cr0/http-client

CR0 HTTP Client - Request library focused on practicality and simplicity

1.2.0 2024-04-20 17:29 UTC

This package is auto-updated.

Last update: 2025-01-20 23:37:35 UTC


README

Você pode instalar esta biblioteca via Composer. Execute o seguinte comando:

bashCopy codecomposer require cr0/http-client

Uso

Uso Básico

Para começar a usar o CR0 HTTP Client, siga estas etapas:

  1. Instancie o Cliente: Crie uma instância do cliente passando a URL base do serviço que você deseja acessar.

  2. Configure a Requisição: Defina os cabeçalhos, o método da requisição, os parâmetros de consulta (query) e o corpo da requisição conforme necessário.

  3. Envie a Requisição: Use o método send() para enviar a requisição para o endpoint desejado.

  4. Obtenha a Resposta: A resposta será retornada como um objeto HttpResponse, do qual você pode extrair o corpo, os cabeçalhos e o código de status.

Aqui está um exemplo de uso básico:

phpCopy code<?php

use CR0<span class="hljs-title">HTTPClient<span class="hljs-title">Client; use CR0<span class="hljs-title">HTTPClient<span class="hljs-title">Api<span class="hljs-title">HttpResponse;

// Instancie o cliente com uma URL base $client = new Client('https://api.example.com');

// Defina cabeçalhos $client->setHeader([ 'Authorization' => 'Bearer SEU_TOKEN_DE_ACESSO', 'Content-Type' => 'application/json' ]);

// Defina o método da requisição $client->setMethod('POST');

// Adicione parâmetros de consulta (query) $client->addQuery('page', 1);

// Defina o corpo da requisição $client->setBody(json_encode(['key' => 'value']));

// Envie a requisição $response = $client->send('/endpoint');

// Obtenha o corpo da resposta $body = $response->getBody();

// Obtenha os cabeçalhos da resposta $headers = $response->getHeaders();

// Obtenha o código de status da resposta $status = $response->getStatusCode();

Personalização

O CR0 HTTP Client oferece várias opções de personalização:

  • Definindo o Tipo de Requisição: Você pode especificar o tipo de requisição usando os métodos isJson() ou isForm().

  • Lidando com Redirecionamentos: Defina o número máximo de redirecionamentos permitidos usando o método setMaxRedirect().

  • Definindo Timeouts: Você pode definir timeouts de requisição usando o método setTimeout().

Aqui está um exemplo de como usar essas opções:

phpCopy code$client->isJson(); // Define o tipo de requisição para JSON
$client->setMaxRedirect(3); // Permite no máximo 3 redirecionamentos
$client->setTimeout(30, 30); // Define o timeout e o timeout expirado para 30 segundos cada

Contribuição

Contribuições são bem-vindas! Se você encontrou um bug, tem uma sugestão ou deseja adicionar uma nova funcionalidade, sinta-se à vontade para abrir uma issue ou enviar um pull request.

Licença

Esta biblioteca é licenciada sob a Licença MIT. Você tem permissão para usar, modificar e distribuir livremente.

Este README fornece uma visão geral detalhada da biblioteca CR0 HTTP Client, incluindo instruções detalhadas de uso, opções de personalização, informações de contribuição e informações de licenciamento. Sinta-se à vontade para expandir com mais exemplos ou informações conforme necessário.