Download the PHP package lessmore92/api-consumer without Composer
On this page you can find all versions of the php package lessmore92/api-consumer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lessmore92/api-consumer
More information about lessmore92/api-consumer
Files in lessmore92/api-consumer
Package api-consumer
Short Description Build REST API consumer easier than ever
License mit
Informations about the package api-consumer
api-consumer
Build REST API consumer (client) easier than ever
Installing
Easily install it through Composer:
Support
Usage
Easily extends your class from and impalements method, and builds your awesome API Client.
Example:
Below is the minimum requirement to start building API client: ConfigApi
If the api key needs to be placed in the query string use setQueryApiKey
instead of setHeaderApiKey
for example $api->setQueryApiKey('API-TOKEN','TOKEN');
The Magic of $this->Request()
By inheriting your class will be able to utilize method, which supports chaining. With you will be able to access all the features and functionalities to make your request.
Define your first method to receive data from api: Simple GET Request
To specify an endpoint to be called, you must use ->Endpoint()
method. After that by chaining ->Get()
method at the end, REQUEST METHOD is specified as GET
.
In the above example we defined a method to GET
Users
list from server.
By calling Users()
method, in fact we are getting https://MY-API-BASE-URL.COM/users
Make another request: Add Query String
To pass data in query string (e.g to search, order or filter) you can use ->AddQueryString()
method.
In the above example we defined a method to search in users.
By calling SearchUsers('alex')
method, in fact we are getting https://MY-API-BASE-URL.COM/users?search=alex
Make another request: Get result in json format
To receive data as json
, you must use ->AcceptJson()
method.
As you can see in the code above, by chaining ->AcceptJson()
in request we are telling to api server that we accept json
, then in the return
line we are returning a json formatted search result.
For json
data format, your api server must be able to provide json formatted response and support HEADER 'accept : application/json'