PHP REST Api Download - PHP REST Api Quellcode herunterladen

Rest-api

Dies ist ein PHP-REST-API, das die grundlegende HTTP-Authentifizierung verwendet. Da die grundlegende HTTP -Authentifizierung codiert, aber nicht verschlüsselt ist, wird dringend empfohlen, eine sichere Verbindung (HTTPS) und ein starkes Kennwort zu verwenden.

Wenn Sie diese API zum Umgang mit sensiblen Daten verwenden, tun Sie dies auf eigenes Risiko.

Inhaltsverzeichnis

Konfiguration
- Richten Sie eine MySQL -Datenbank ein
- Starten Sie PHP Build in Webserver
- Authentifizierung
- Setzen Sie Anmeldeinformationen
Einen Dienst erstellen
So verwenden Sie die API
- Holen Sie sich eine Sammlung
- Holen Sie sich einen einzelnen Artikel
- Erstellen Sie ein neues Element
- Aktualisieren Sie einen Artikel
- Einen Artikel löschen
Verlängerte Verwendung
- Spezialaufgaben ausführen
HTTP -Statuscodes
Hinzufügen von Middleware
Autor
Lizenz

Konfiguration

Richten Sie eine MySQL -Datenbank ein

Richten Sie einen MySQL -Server ein und führen Sie example_database.sql aus. Geben Sie die zugehörigen MySQL -Parameter in settings.php ein.

Starten Sie PHP Build in Webserver

 $ php -S localhost:2400 -t public

Authentifizierung

Die Authentifizierung ist standardmäßig aktiviert. Sie können es in settings.php deaktivieren.

Setzen Sie Anmeldeinformationen

Die folgenden Anmeldeinformationen sind derzeit in lib/Authentication Middleware kodiert. Es liegt an Ihnen, eine ordnungsgemäße Logik zu implementieren.

 $ username = " rest " ;
$ password = " test " ;

Einen Dienst erstellen

Sie erstellen Dienste im services und im spezifischen Versionsordner. Ein Dienst erbt immer von abstrakter Klassen -Webservice . Hier ist eine grundlegende Vorlage, mit der Sie schnell beginnen können:

 use RESTapi  Sources  Request ;
use RESTapi  Sources  Response ;
use RESTapi  Sources  WebService ;
use RESTapi  Library  Database ;

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 );
    }
}

Arbeiten mit der Datenbank:
Bitte überprüfen Sie den Users , um zu lernen und zu verstehen, wie Sie Abfragen zur Durchführung von CRUD -Operationen erstellen.

So verwenden Sie die API

Holen Sie sich eine Sammlung

Verwendung: 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 );

Holen Sie sich einen einzelnen Artikel

Verwendung: 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 );

Erstellen Sie ein neues Element

Verwendung: 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 );

Aktualisieren Sie einen Artikel

Verwendung: 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 );

Einen Artikel löschen

Verwendung: 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 );

Verlängerte Verwendung

Spezialaufgaben ausführen

Ein Dienst erbt standardmäßig vier Funktionen get , post , put und delete . Diese sind perfekt, um Crud -Aktionen in einer Datenbank auszuführen. Aber was ist, wenn Sie einen Service benötigen, der einige besondere Aufgaben erledigen sollte? In einem solchen Fall können Sie das PATCH HTTP Request -Methode verwenden und den Namen der Aktion im URI angeben.

Nachfolgend finden Sie ein Beispiel für einen Caluculationsdienst, der zwei Zahlen multipliziert:

Verwendung: 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 );

HTTP -Statuscodes

Die API antwortet mit den folgenden Statuscodes. Sie können dies nach Ihren Wünschen ändern:

Auf Erfolg:

Holen Sie sich: 200 ok
Beitrag: 201 erstellt
Setzen Sie: 204 Kein Inhalt oder 202 akzeptiert
Löschen: 205 Inhalt zurücksetzen

Ansonsten:

400 schlechte Anfrage
401 nicht autorisiert
404 nicht gefunden
500 interner Serverfehler

Hinzufügen von Middleware

Im Folgenden finden Sie ein Beispielmuster, mit dem Sie Ihre eigene Middleware erstellen können. Sie können Ihre eigene Middleware erstellen, indem Sie eine Klasse im lib -Ordner erstellen, der die IMiddleware -Schnittstelle implementiert:

 class YourMiddleware implements IMiddleware {

    public function handle ( Request $ request , Response $ response ): void {}
}

Um Middleware in eine andere Middleware zu injizieren, verwenden Sie den Konstruktor dieser 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 );