Erfahren Sie, wie Sie RESTful-APIs mit PHP und MySQL erstellen-PHP-Tutorial-php.cn

Mit der Entwicklung der Webentwicklung ist die RESTful API zu einem der Standards für moderne Webanwendungen geworden. Im Vergleich zu herkömmlichen APIs sind RESTful-APIs flexibler und skalierbarer. PHP und MySQL können als weit verbreitete Webentwicklungstools auch zum Erstellen von RESTful-APIs verwendet werden. In diesem Artikel wird detailliert beschrieben, wie Sie eine RESTful-API mit PHP und MySQL erstellen, und es werden Codebeispiele und Überlegungen bereitgestellt.

1. Einführung in die RESTful API

RESTful API ist eine Web-API-Designform, die auf dem HTTP-Protokoll und dem Standarddatenformat basiert. Normalerweise werden HTTP-Verben (GET, POST, PUT, DELETE usw.) verwendet, um Ressourcen zu bearbeiten, und HTTP-Statuscodes werden verwendet, um die Operationsergebnisse darzustellen. Zu den Designprinzipien der RESTful API gehören Ressourcen, repräsentative Zustandsübertragung, einheitliche Schnittstelle, Eigenständigkeit und Hypermedia.

2. Erstellen Sie eine RESTful-API mit PHP und MySQL

Installieren und konfigurieren Sie PHP und MySQL

Zuerst müssen Sie PHP und MySQL installieren und konfigurieren, was hier nicht beschrieben wird. Nach Abschluss der Installation können Sie mit der Funktion phpinfo überprüfen, ob PHP ordnungsgemäß funktioniert, oder eine Testdatenbank in MySQL erstellen, um zu überprüfen, ob MySQL ordnungsgemäß funktioniert.

Erstellen Sie die Grundstruktur der RESTful API

Als nächstes müssen Sie die Grundstruktur der RESTful API erstellen. Die erste ist die Datenbankverbindung unter Verwendung des folgenden Codes:

<?php
 
//数据库连接参数 
define('DB_HOST', 'localhost'); 
define('DB_USER', 'root'); 
define('DB_PASS', ''); 
define('DB_NAME', 'test');
 
//建立数据库连接 
function connect() {
    $mysqli = new mysqli(DB_HOST, DB_USER, DB_PASS, DB_NAME);
    if(mysqli_connect_errno()) {
        die("Database connection failed: " . mysqli_connect_error());
    }
    return $mysqli;
}
 
//关闭数据库连接 
function disconnect($mysqli) {
    $mysqli -> close();
}
 
?>

Nach dem Login kopieren

Es ist zu beachten, dass hier die objektorientierte MySQL-Verbindung anstelle der herkömmlichen MySQL-Verbindungsmethode verwendet wird.

Als nächstes müssen Sie eine grundlegende RESTful-API-Klasse erstellen, die das Verhalten von HTTP-Anfragen und -Antworten definiert. Hier sind vier HTTP-Verben definiert: GET, POST, PUT und DELETE. Verwenden Sie den folgenden Code:

<?php
 
require_once('db_connect.php');
 
class Rest {
 
    protected $request;
    protected $mysqli;
    protected $method;
    protected $args;
    protected $resource = '';
    protected $statusCodes = array(
        200 => 'OK',
        201 => 'Created',
        202 => 'Accepted',
        204 => 'No Content',
        400 => 'Bad Request',
        401 => 'Unauthorized',
        403 => 'Forbidden',
        404 => 'Not Found',
        406 => 'Not Acceptable',
        500 => 'Internal Server Error'
    );
 
    public function __construct() {
        $this -> mysqli = connect();
        $this -> request = explode('/', trim($_SERVER['PATH_INFO'], '/'));
        $this -> method = $_SERVER['REQUEST_METHOD'];
        $this -> args = $_SERVER['QUERY_STRING'];
        $this -> resource = array_shift($this -> request);
    }
 
    public function processRequest() {
 
        switch($this -> method) {
            case 'POST':
                $response = $this -> create();
                break;
            case 'PUT':
                $response = $this -> update();
                break;
            case 'DELETE':
                $response = $this -> delete();
                break;
            case 'GET':
            default:
                $response = $this -> read();
                break;
        }
 
        header('HTTP/1.1 ' . $this -> statusCodes[$response['status']]);
        header('Content-Type: application/json; charset=utf-8');
 
        return json_encode($response['data']);
    }
 
    protected function create() {}
    protected function read() {}
    protected function update() {}
    protected function delete() {}
 
}
 
?>

Nach dem Login kopieren

Der Konstruktor dieser Klasse analysiert die Methode, den Pfad und die Parameter in der HTTP-Anfrage und speichert sie in den Objekteigenschaften. Rufen Sie dann die entsprechende Methode entsprechend der HTTP-Methode auf, um die Anforderung zu verarbeiten.

CRUD-Operationen der RESTful-API implementieren

Als nächstes müssen Sie CRUD-Operationen in der RESTful-API-Klasse implementieren. Nehmen Sie den Benutzer als Beispiel und verwenden Sie den folgenden Code:

class UserAPI extends Rest {
 
    public function create() {
        $data = json_decode(file_get_contents("php://input"), true);
        $username = $data['username'];
        $password = $data['password'];
        $email = $data['email'];
 
        if(!empty($username) && !empty($password) && !empty($email)) {
            $stmt = $this -> mysqli -> prepare("INSERT INTO users (username, password, email) VALUES (?, ?, ?)");
            $stmt -> bind_param("sss", $username, $password, $email);
            $stmt -> execute();
            $stmt -> close();
            $response['status'] = 201;
            $response['data'] = "User created successfully.";
        } else {
            $response['status'] = 400;
            $response['data'] = "Invalid parameters.";
        }
 
        return $response;
    }
 
    public function read() {
        $id = array_shift($this -> request);
        if(empty($id)) {
            $result = $this -> mysqli -> query("SELECT * FROM users");
            while($row = $result -> fetch_assoc()) {
                $data[] = $row;
            }
            $response['status'] = 200;
            $response['data'] = $data;
        } else {
            $result = $this -> mysqli -> query("SELECT * FROM users WHERE id = $id");
            if($result -> num_rows == 1) {
                $response['status'] = 200;
                $response['data'] = $result -> fetch_assoc();
            } else {
                $response['status'] = 404;
                $response['data'] = "User not found.";
            }
        }
        return $response;
    }
 
    public function update() {
        $id = array_shift($this -> request);
        $data = json_decode(file_get_contents("php://input"), true);
        $username = $data['username'];
        $password = $data['password'];
        $email = $data['email'];
 
        if(!empty($username) && !empty($password) && !empty($email)) {
            $stmt = $this -> mysqli -> prepare("UPDATE users SET username=?, password=?, email=? WHERE id=?");
            $stmt -> bind_param("sssi", $username, $password, $email, $id);
            $stmt -> execute();
            $stmt -> close();
            $response['status'] = 200;
            $response['data'] = "User updated successfully.";
        } else {
            $response['status'] = 400;
            $response['data'] = "Invalid parameters.";
        }
 
        return $response;
    }
 
    public function delete() {
        $id = array_shift($this -> request);
        $result = $this -> mysqli -> query("SELECT * FROM users WHERE id = $id");
        if($result -> num_rows == 1) {
            $this -> mysqli -> query("DELETE FROM users WHERE id = $id");
            $response['status'] = 200;
            $response['data'] = "User deleted successfully.";
        } else {
            $response['status'] = 404;
            $response['data'] = "User not found.";
        }
        return $response;
    }
 
}

Nach dem Login kopieren

Hier wird eine UserAPI-Klasse definiert, die die Methoden zum Erstellen, Lesen, Aktualisieren und Löschen implementiert. Bei POST-Anfragen werden die Json-Daten in Benutzernamen, Passwörter und E-Mail-Adressen analysiert und bei GET-Anfragen in die Benutzertabelle eingefügt. Wenn die URL den ID-Parameter enthält, werden die entsprechenden Benutzerinformationen zurückgegeben, andernfalls werden alle Benutzerinformationen zurückgegeben zurückgegeben werden; für PUT-Anforderungen JSON-Daten in Benutzername, Passwort und E-Mail-Adresse analysieren und die entsprechenden Benutzerinformationen aktualisieren, für DELETE-Anforderungen den entsprechenden Benutzer gemäß dem ID-Parameter in der URL löschen.

Verwenden der RESTful-API

Nachdem Sie die RESTful-API erstellt haben, können Sie Tools wie Curl verwenden, um zu testen, ob die API ordnungsgemäß funktioniert. Verwenden Sie den folgenden Curl-Befehl, um Benutzer für die RESTful-API zu erstellen:

curl -H "Content-Type: application/json" -X POST -d '{
    "username":"testuser",
    "password":"testpassword",
    "email":"testuser@example.com"
}' http://localhost/user

Nach dem Login kopieren

Verwenden Sie den folgenden Curl-Befehl, um alle Benutzer zurückzugeben:

curl http://localhost/user

Nach dem Login kopieren

Verwenden Sie den folgenden Curl-Befehl, um Benutzerinformationen zu aktualisieren:

curl -H "Content-Type:application/json" -X PUT -d '{
    "username":"newusername",
    "password":"newpassword",
    "email":"newusername@example.com"
}' http://localhost/user/1

Nach dem Login kopieren

Verwenden Sie den folgenden Curl-Befehl, um Benutzer zu löschen :

curl -X DELETE http://localhost/user/1

Nach dem Login kopieren

3. Vorsichtsmaßnahmen

Sie müssen beim Erstellen einer RESTful-API auf die folgenden Punkte achten:

Datenbanksicherheit. RESTful-APIs müssen normalerweise mit Datenbanken interagieren, und es können Sicherheitsprobleme wie SQL-Injection auftreten. Um die Datensicherheit zu gewährleisten, müssen parametrisierte Abfragen und andere Methoden verwendet werden.
Domänenübergreifende Probleme. Die RESTful-API kann von Anwendungen unter unterschiedlichen Domänennamen aufgerufen werden, was zu domänenübergreifenden Problemen führt. Access-Control-Allow-Origin und andere verwandte HTTP-Header müssen festgelegt werden.
API-Versionskontrolle. Beim Entwerfen von RESTful-APIs muss die Versionskontrolle berücksichtigt werden, um eine Beeinträchtigung vorhandener APIs zu vermeiden.
HTTP-Statuscode. Der Rückgabewert der RESTful-API muss den HTTP-Statuscode korrekt verwenden, um das Ergebnis der Anfrage darzustellen.

4. Zusammenfassung

Dieser Artikel stellt vor, wie man PHP und MySQL zum Erstellen einer RESTful-API verwendet, und bietet Codebeispiele und Vorsichtsmaßnahmen. Die Vorteile der RESTful API sind Flexibilität, Skalierbarkeit, einfache Wartung usw. Sie ist ein unverzichtbarer Bestandteil der Webentwicklung. Bei der Verwendung von RESTful-APIs müssen Sie auf Aspekte wie Sicherheit, domänenübergreifende Probleme, Versionskontrolle und HTTP-Statuscodes achten.

Das obige ist der detaillierte Inhalt vonErfahren Sie, wie Sie RESTful-APIs mit PHP und MySQL erstellen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!