caiolandgraf/requestapi

Biblioteca para consumo e envio de formulários e api's

1.0.0 2020-09-16 15:31 UTC

This package is auto-updated.

Last update: 2024-11-18 02:47:51 UTC


README

Maintainer Source Code PHP from Packagist Latest Version Software License Build Quality Score Total Downloads

RequestApi Library is a small set of classes developed by Suporte Informátika to facilitate communication with API's and third-party forms...

RequestApi Library é um pequeno conjunto de classes desenvolvidas pela Suporte Informátika para facilitar a comunicação com API's e formulários de terceiros.

Você pode saber mais clicando aqui.

Highlights

  • Simple installation (Instalação simples)
  • Easy abstraction of API's (Facíl abstração de API's)
  • Easy implementation with forms (Facíl implementação com formulários)
  • Composer ready and PSR-2 compliant (Pronto para o composer e compatível com PSR-2)

Installation

Uploader is available via Composer:

"caiolandgraf/requestapi": "^1.0"

or run

composer require caiolandgraf/requestapi

Documentation

For details on how to use, see a sample folder in the component directory. In it you will have an example of use for each class. It works like this:

Para mais detalhes sobre como usar, veja uma pasta de exemplo no diretório do componente. Nela terá um exemplo de uso para cada classe. Ele funciona assim:

Api's Abstraction :

<?php

require __DIR__ . "/../vendor/autoload.php";

use CaioLandgraf\Api\RequestApi;

$request = new RequestApi("https://www.apiurl.com");

// login
$request->post([
    "login" => "email@suporteinformatika.com.br",
    "password" => "password"
], "login");

// read
$user = $request->get([
    "id" => "1"
], "user");

//update
$user->put([
    "first_name" => "Caio",
    "last_name" => "Landgraf",
    "genre" => "male",
    "datebirth" => "1980-01-02",
    "document" => "888888888"
], "user/update");

//test and result
if ($user->error()) {
    $user->error(); //object
} else {
    $user->response(); //object
}

Form abstraction

<?php

require __DIR__ . "/../vendor/autoload.php";

use CaioLandgraf\Api\RequestApi;

$request = new RequestApi("https://www.form.com/contact");

$request->post([
    "name" => "Name",
    "email" => "email@suporteinformatika.com.br",
    "subject" => "Subject",
    "message" => "Message"
]);

//test and result
if ($request->error()) {
    $request->error(); //object
} else {
    $request->response(); //object
}

Contributing

Please see CONTRIBUTING for details.

Support

Security: If you discover any security related issues, please email eu.caiolandgraf@gmail.com instead of using the issue tracker.

Se você descobrir algum problema relacionado à segurança, envie um e-mail para eu.caiolandgraf@gmail.com em vez de usar o rastreador de problemas.

Thank you

Credits

License

The MIT License (MIT). Please see License File for more information.