PHP REST Api
1.0.0
This is a PHP REST-Api using Basic HTTP Authentication. Since Basic HTTP Authentication is encoded but NOT encrypted it is highly recommended to use a secure connection (HTTPS) and a strong password.
If you use this API for handling sensitive data, you do it at your own risk.
Set up a MySQL server and execute example_database.sql. Enter the related MySQL parameters in settings.php.
$ php -S localhost:2400 -t public
Authentication is enabled by default. You can disable it in settings.php.
The below credentials are currently hard coded in lib/Authentication middleware. It's up to you to implement a proper logic.
$username = "rest";
$password = "test";You create services in the services directory and the specific version folder. A Service always inherits from abstract class WebService. Here is a basic template that you can use to quickly get started:
use RESTapiSourcesRequest;
use RESTapiSourcesResponse;
use RESTapiSourcesWebService;
use RESTapiLibraryDatabase;
class YourService extends WebService {
private Database|null $db;
public function __construct()
{
$this->db = Database::getInstance();
}
public function get(Request $request, Response $response): void
{
// Your logic here ...
$affectedRows = 12;
$response->write("JSON"); // Add a JSON object
$response->addHeader("X-Data-Count", $affectedRows);
$response->setStatus(200);
}
public function post(Request $request, Response $response): void
{
// Your logic here ...
$affectedRows = 12;
$response->write("JSON"); // Add a JSON object
$response->addHeader("X-Insert-Count", $affectedRows);
$response->setStatus(201);
}
public function put(Request $request, Response $response): void
{
// Your logic here ...
$affectedRows = 1;
$response->write("JSON"); // Add a JSON object
$response->addHeader("X-Update-Count", $affectedRows);
$response->setStatus(204);
}
public function delete(Request $request, Response $response): void
{
// Your logic here ...
$affectedRows = 1;
$response->write("JSON"); // Add a JSON object
$response->addHeader("X-Delete-Count", $affectedRows);
$response->setStatus(205);
}
}Working with the database:
Please checkout theUsersService to learn and understand how to create queries to perform CRUD operations.
Usage: GET domain.tld/[version]/[service]
$ch = curl_init("http://localhost:2400/v1/Users/");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
curl_setopt($ch, CURLOPT_HEADER, true);
if (!$output = curl_exec($ch)) {
trigger_error(curl_error($ch));
}
curl_close($ch);Usage: GET domain.tld/[version]/[service]/[id]
$ch = curl_init("http://localhost:2400/v1/Users/3");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
curl_setopt($ch, CURLOPT_HEADER, true);
if (!$output = curl_exec($ch)) {
trigger_error(curl_error($ch));
}
curl_close($ch);Usage: POST domain.tld/[version]/[service]
$body = [
"name" => "Greta Garbo",
"age" => "93",
"city" => "Hollywood",
"country" => "California"
];
$ch = curl_init("http://localhost:2400/v1/Users");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($body));
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
curl_setopt($ch, CURLOPT_HEADER, true);
if (!$output = curl_exec($ch)) {
trigger_error(curl_error($ch));
}
curl_close($ch);Usage: PUT domain.tld/[version]/[service]/[id]
$body = [
"name" => "John Rambo",
"age" => "42",
"city" => "Seattle",
"country" => "Washington"
];
$ch = curl_init("http://localhost:2400/v1/Users/4");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($body));
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
curl_setopt($ch, CURLOPT_HEADER, true);
if (!$output = curl_exec($ch)) {
trigger_error(curl_error($ch));
}
curl_close($ch);Usage: DELETE domain.tld/[version]/[service]/[id]
$ch = curl_init("http://localhost:2400/v1/Users/1");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
curl_setopt($ch, CURLOPT_HEADER, true);
if (!$output = curl_exec($ch)) {
trigger_error(curl_error($ch));
}
curl_close($ch);A Service inherits four functions get, post, put and delete from the abstract WebService class by default. Those are perfect to perform CRUD actions on a Database. But what if you need a Service that should do some special tasks? In such a case you can use the HTTP request method PATCH and provide the name of the action in the URI.
Below is an example of a caluculation Service that multiplies two numbers:
Usage: PATCH domain.tld/[version]/[service]/[action]
$ch = curl_init("http://localhost:2400/v1/Calculator/multiply");
$body = [
"a" => 12,
"b" => 2.5
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($body));
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
curl_setopt($ch, CURLOPT_HEADER, true);
if (!$output = curl_exec($ch)) {
trigger_error(curl_error($ch));
}
curl_close($ch);The API responds with the following Status Codes. You can change this to your liking:
On Success:
Otherwise:
Below is an example pattern that you can use to build your own middleware. You can create your own middleware by creating a class in the lib folder that implements the IMiddleware interface:
class YourMiddleware implements IMiddleware {
public function handle(Request $request, Response $response): void {}
}To inject middleware into another middleware use the constructor of that middleware:
class YourMiddleware implements IMiddleware {
public function __construct(private IMiddleware $anotherMiddleware) {}
public function handle(Request $request, Response $response): void
{
// 1. Add your logic ...
// 2. Handle Middleware ...
$this->anotherMiddleware->handle($request, $response);
// 3. Do something afterwards ...
}
}
$anotherMiddleware = new AnotherMiddleware();
$yourMiddleware = new YourMiddleware($anotherMiddleware);
$yourMiddleware->handle($request, $response);Martin Wolf
MIT
