mirror of
https://codeberg.org/reflect/reflect-client-php.git
synced 2025-09-13 17:43:42 +02:00
Victor Westerlund
c819bc3da2
* wip: 1682605782 * wip: 1682607489 * wip: 1682607562 * wip: 1682608764 * wip: 1682609355 * wip: 1682609830 * wip: 1682609969 * feat(doc): add API key reference
91 lines
2.9 KiB
Markdown
91 lines
2.9 KiB
Markdown
# Reflect API client for PHP
|
|
|
|
Make requests to an API built using the [Reflect API](https://github.com/VictorWesterlund/reflect) framework over HTTP or UNIX sockets. This program comes with both an extendable/instantiable class that you can integrate with existing PHP code, or as a stand-alone CLI which can be run by itself or UNIX piped into other programs.
|
|
|
|
---
|
|
|
|
Make a request with `Client->call()`. It will always return the response as an array of length 2.
|
|
- The first value is the HTTP-equivalent response code.
|
|
- The second value is the response body
|
|
|
|
```php
|
|
$client = new Reflect\Client("<API URL or path to UNIX socket>", "<API key (optional)>");
|
|
|
|
$client->call("foo", Reflect\Method::GET); // (array) [200, "bar"]
|
|
$client->call("foo", Reflect\Method::POST, [
|
|
"foo" => "bar"
|
|
]); // (array) [201, "Created"]
|
|
|
|
// etc..
|
|
```
|
|
|
|
## How to use
|
|
|
|
Requires PHP 8.1 or newer, and of course a Reflect API endpoint.
|
|
|
|
1. **Install with composer**
|
|
|
|
```
|
|
composer require reflect/client
|
|
```
|
|
|
|
2. **Initialize the class**
|
|
|
|
```php
|
|
require_once "/vendor/autoload.php";
|
|
|
|
$client = new Reflect\Client("<API URL or path to UNIX socket>", "<API key (optional)>");
|
|
```
|
|
|
|
3. **Make API request**
|
|
|
|
Use the `call()` method to perform a request
|
|
|
|
```php
|
|
$client->call("foo?bar=baz", Reflect\Method::GET);
|
|
```
|
|
|
|
Argument index|Type|Required|Description
|
|
--|--|--|--
|
|
0|String|Yes|Fully qualified pathname and query params of the endpoint to call
|
|
1|Method\|string|Yes|A supported [Reflect HTTP method](https://github.com/VictorWesterlund/reflect/wiki/Supported-technologies#http-request-methods) (eg. `Method::GET`) or a string represnetation of a supported method (eg. "GET")
|
|
2|Array|No|An optional indexed, associative, or multidimensional array that will be sent as the request body as `Content-Type: application/json`
|
|
|
|
The `call()` function will return an array of length 2 wil the following information
|
|
|
|
Index|Type|Description
|
|
--|--|--
|
|
0|Int|HTTP-equivalent response code (eg. `200` or `404`)
|
|
1|String/Array|Contains the response body as either a string, or array if the response `Content-Type` header is `application/json`
|
|
|
|
## How to use (CLI)
|
|
|
|
You can also run this from the command line with
|
|
|
|
```
|
|
php client <socket_file> <endpoint> <http_method> [payload]
|
|
```
|
|
|
|
and it will return a serialized JSON array with the same structure as described in the `Client->call()` return.
|
|
|
|
*Example*
|
|
```sh
|
|
php client "/run/reflect.sock" "foo?bar=biz" "POST" "[\"foo\" => \"bar\"]" # (string) [201, \"Created\"]
|
|
```
|
|
|
|
---
|
|
|
|
Requires PHP CLI 8.1 or greater, and of course a Reflect API endpoint.
|
|
|
|
1. **Clone repo**
|
|
|
|
```
|
|
git clone https://github.com/victorwesterlund/reflect-client-php
|
|
```
|
|
|
|
2. **Run from command line**
|
|
|
|
```
|
|
// From the root directory of this project
|
|
php client <url_or_socket_file_path> <endpoint> <http_method> [payload]
|
|
```
|