lde / api-helper
Laravel package to help consume REST and XML APIs with little effort.
Installs: 13 103
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 6
Forks: 3
Open Issues: 1
Requires
- php: ^7.4|^8.0
- adbario/php-dot-notation: ^2.x.dev
- guzzlehttp/guzzle: ^7.0.1
- spatie/array-to-xml: ^2.16.0
Requires (Dev)
- orchestra/testbench: ~3.6.0|~3.7.0|~3.8.0|~5.0.0
- phpunit/phpunit: ^8.5|9.0|^9.5
- dev-master
- 8.0.1
- 8.0.0
- 7.0.x-dev
- 7.0.0
- 6.0.0
- 0.1.30
- 0.1.29
- 0.1.28
- 0.1.27
- 0.1.26
- 0.1.25
- 0.1.24
- 0.1.23
- 0.1.22
- 0.1.21
- 0.1.20
- 0.1.19
- 0.1.18
- 0.1.17
- 0.1.16
- 0.1.15
- 0.1.14
- 0.1.13
- 0.1.12
- 0.1.11
- 0.1.10
- 0.1.9
- 0.1.8
- 0.1.7
- 0.1.6
- 0.1.5
- 0.1.4
- 0.1.3
- 0.1.2
- 0.1.1
- 0.1.0
- 0.0.0
- dev-feature/changelog
- dev-feature/checking_testcase_failure
- dev-testcaseformparams
- dev-formdatasupport
- dev-revert-25-dependabot/composer/symfony/http-foundation-4.4.1
This package is auto-updated.
Last update: 2025-03-17 07:26:12 UTC
README
Api Helper Package
A package to consume api smoothly
Explore the docs »
View Package
·
Report Bug
·
Request Feature
Table of Contents
Getting Started
This package is useful to consume API's, here is the instruction for installation and usage.
Installation
-
To install this package using Packagist
-
On the root of your project run following command
composer require lde/api-helper
-
This command will install package with dependency
Configuration
-
To use this apihelper need to export config file to do so run the following command in your terminal to publish config file to config folder.
php artisan vendor:publish --provider="Lde\ApiHelper\ApiHelperServiceProvider"
-
This will publish config file naming api_helper.php into config folder.
Prometheus Configuration
-
Prometheus is dependent on your app so you need to provide prometheus configuration and also use below packages on your app.
-
If you want to use prometheus then you should turn it on from config api_helper
'log_stats' => true, // If you want to use prometheus then set as true otherwise false 'prometheus' => [ 'labels' => [ 'client_id' => 10, 'app' => 'api-helper', 'source' => 'core', ], 'histogram_bucket' => [0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 3.0, 3.5, 4.0, 4.5, 5.0, 7.5, 10.0], ],
- You can configure labels of prometheus inside
prometheus.labels
as per your need. histogram_bucket
you can set inside prometheus config as array.
Usage
-
To use this package you need to add following class where you want to use this package.
use Lde\ApiHelper\ApiBuilder;
Methods
addHeaders($headers)
-
This method is use to add headers.
-
It accept name and value as parameter, Here you can set only one header at a time.
$headers['Accept'] = "application/json"; $headers['Content-Type'] = "application/json"; app(ApiBuilder::class)->addHeaders($headers);
-
We will get response in form of object of ApiBuilder.
api($connection)
-
This method is use to set api that we are going to use from api_helper.php , there is httpbin and mokbin is define so you have to pass the name that you want to use.
-
You can also define your own api end point at api_helper.php in config file.
app(ApiBuilder::class)->api('httpbin')->method_to_call();
-
The snippet indicates how you can connect particular api and access their method.
-
method_to_call() is the function that you have specified inside api_helper connection array.
-
This will return object of ApiResponse.
Response
- Here you will get object in response, In each response you will get success either true or false
- You will also get status code for more information about response please check below doc.
- http://docs.guzzlephp.org/en/latest/psr7.html#responses