README

RApi

Cliente PHP para API REST, uma maneira simples e rápida de comunicar sua aplicação PHP com outras APIs. Esta biblioteca utiliza a extensão cURL.

Instalação

composer require prdossantos/rapi:v1.0.2beta

Exemplos

Instanciando a classe

use App\RApi;

Configurações

RApi::setConfig('host','http://api.domain.com');

//Podemos setar varias config de uma vez.
RApi::setConfig(array(
	'host' => 'http://api.domain.com',
	'ssl' => 'cert.pem'
));

GET

//Todas as requisições devem conter uma chamada a função run()

RApi::get('/')->run();

//Passando parâmetros, o retorno será um objeto
$res = RApi::get('/')
       ->fields(['user'=>'test','pass'=>'***'])
       ->run();

//Passando parâmetros e informado headers, o retorno será um objeto
$res = RApi::get('/')
       ->fields(['user'=>'test','pass'=>'***'])
       ->header(['Content-Type: application/json', 'Accept: application/json'])
       ->run(); 

//Podemos passar parâmetros e headers no método, simplificando as coisas.
$res = RApi::post('http://api.domain.com/auth',['username'=>'asdf','password'=>'***'],['Content-Type: application/json']);

#output
$res->response; // Resultado da consulta
$res->info;     // array com informações da requisição
$res->header;   // array com header do resultado da consulta

Métodos disponíveis

• get
• post
• put
• delete

Funções disponíveis

• fields(array $fields)
• header(array $headers)
• cookie(string $cookie)
• run()

##Testes Instale o composer

//Instalando as dependências necessárias
composer install

//Rodando os testes
phpunit