PHP MVC REST API

Richtlinie für die Verwendung von PHP -MVC -REST -API

Was ist REST -API?

Eine REST -API (auch als Restful -API bezeichnet) ist eine Anwendungsprogrammierschnittstelle (API oder Web -API), die den Einschränkungen des REST -Architekturstils entspricht und die Interaktion mit ruhigen Webdiensten ermöglicht. REST steht für Repräsentationsstaattransfer und wurde von Informatiker Roy Fielding erstellt.

Eine API ist eine Reihe von Definitionen und Protokollen zum Erstellen und Integrieren von Anwendungssoftware. Es wird manchmal als Vertrag zwischen einem Informationsanbieter und einem Informationsbenutzer bezeichnet - die vom Verbraucher erforderlichen Inhalte (der Anruf) und den vom Produzent erforderlichen Inhalt (die Antwort) einbezogen werden. Zum Beispiel könnte das API-Design für einen Wetterdienst angeben, dass der Benutzer eine Postleitzahl liefert und dass der Hersteller mit einer zweiteiligen Antwort antwortet, wobei die erste die hohe Temperatur ist und der zweite das niedrige ist.

Einführung

Das Framework leitet einfach Anfragen an den richtigen Controller und Modell weiter. Dies erfolgt durch Analyse von URI für den Controller -Namen und den Anforderungstyp (sei es Post, setzen, erhalten, usw.). Anschließend werden einige Gesundheitsprüfungen durchgeführt, bevor ein neues Controller- und Modellobjekt initialisiert und die richtige Methode auf dem Controller aufgerufen wird.

Dokumentation

Fügen Sie eine neue Route hinzu

Zum Erstellen einer neuen Route sollten Sie die Route.php -Datei aus dem Router -Verzeichnis öffnen.

Es gibt bereits einige Beispiele in der Datei, die Sie nach Bedarf verwenden können.

 <?php

$ router -> get ( ' /home ' , ' home@index ' );

$ router -> post ( ' /home ' , ' home@post ' );

$ router -> get ( ' / ' , function () {
    echo ' Welcome ' ;
});

Um Parameter zu erhalten, folgen Sie unten Beispiel:

 <?php

$ router -> get ( ' /:name ' , function ( $ param ) {
    echo ' Welcome ' . $ param [ ' name ' ];
});

Wenn ich beispielsweise diese URL "Yourdomin.com/afgprogrammer" verwende, werde ich die folgende Ausgabe erhalten.

 Welcome afgprogrammer

Es ist nur ein Kinderspiel :)

Wenn Sie die Postanfragen senden möchten, folgen Sie unten Beispiel:

 $ router -> post ( ' /:name ' , function ( $ param ) {
    echo ' Welcome ' . $ param [ ' name ' ];
});

Datenbankverbindung

Beachten Sie, dass Sie zur Verwendung von Datenbank die Datei config.php bearbeiten sollten, bevor Sie die Datenbank verwenden.

Um eine Datenbankverbindung zu erhalten, können Sie im Modellverzeichnis unten Beispiel verwenden:

 <?php

use MVC  Model ;

class ModelsHome extends Model {

    public function getAllUser () {
        $ query = $ this -> db -> query ( " SELECT * FROM " . DB_PREFIX . " user " );
        
        /*
          $query->row : return 1 row
          $query->rows : return all rows
          $query->num_rows : return rows count
        */
        return $ query -> rows ;
    }
}