Basic RESTful API Beispiel Verwendung von PHP
Ich bin daran eine grundlegende RESTful-API-Beispiel. Derzeit bin ich mit dem Beispiel, das ich gefunden hier aber es hat einige Fehler und ist unvollständig.
Hab ich schon Hinzugefügt, die folgenden Zeilen in meine .htaccess als Beispiel angegeben.
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule api/v1/(.*)$ api/v1/MyAPI.php?request=$1 [QSA,NC,L]
</IfModule>
Mein problem ist aber immer die konkrete Klasse von mir, um zu drucken "12". Ich weiß nicht, welche URL zu besuchen, um zu bekommen die Meldung "12", um auf dem Bildschirm angezeigt werden.
Hier ist meine abstrakte Klasse code:
<?php
abstract class API
{
/**
* Property: method
* The HTTP method this request was made in, either GET, POST, PUT or DELETE
*/
protected $method = '';
/**
* Property: endpoint
* The Model requested in the URI. eg: /files
*/
protected $endpoint = '';
/**
* Property: verb
* An optional additional descriptor about the endpoint, used for things that can
* not be handled by the basic methods. eg: /files/process
*/
protected $verb = '';
/**
* Property: args
* Any additional URI components after the endpoint and verb have been removed, in our
* case, an integer ID for the resource. eg: /<endpoint>/<verb>/<arg0>/<arg1>
* or /<endpoint>/<arg0>
*/
protected $args = Array();
/**
* Property: file
* Stores the input of the PUT request
*/
protected $file = Null;
/**
* Constructor: __construct
* Allow for CORS, assemble and pre-process the data
*/
public function __construct($request) {
header("Access-Control-Allow-Orgin: *"); //any origin can be processed by this page
header("Access-Control-Allow-Methods: *"); //any HTTP method can be accepted
header("Content-Type: application/json");
$this->args = explode('/', rtrim($request, '/'));
$this->endpoint = array_shift($this->args);
if (array_key_exists(0, $this->args) && !is_numeric($this->args[0])) {
$this->verb = array_shift($this->args);
}
$this->method = $_SERVER['REQUEST_METHOD'];
if ($this->method == 'POST' && array_key_exists('HTTP_X_HTTP_METHOD', $_SERVER)) {
if ($_SERVER['HTTP_X_HTTP_METHOD'] == 'DELETE') {
$this->method = 'DELETE';
} else if ($_SERVER['HTTP_X_HTTP_METHOD'] == 'PUT') {
$this->method = 'PUT';
} else {
throw new Exception("Unexpected Header");
}
}
switch($this->method) {
case 'DELETE':
case 'POST':
$this->request = $this->_cleanInputs($_POST);
break;
case 'GET':
$this->request = $this->_cleanInputs($_GET);
break;
case 'PUT':
$this->request = $this->_cleanInputs($_GET);
$this->file = file_get_contents("php://input");
break;
default:
$this->_response('Invalid Method', 405);
break;
}
}
/**
* Determine if the concrete class implements a method for the endpoint that the client requested. If it does, then it calls that method, otherwise a 404
* response is returned
*/
public function processAPI() {
if ((int)method_exists($this->endpoint) > 0) {
return $this->_response($this->{$this->endpoint}($this->args));
}
return $this->_response('', 400);
}
private function _response($data, $status = 200) {
header("HTTP/1.1 " . $status . " " . $this->_requestStatus($status));
return json_encode($data);
}
private function _cleanInputs($data) {
$clean_input = Array();
if (is_array($data)) {
foreach ($data as $k => $v) {
$clean_input[$k] = $this->_cleanInputs($v);
}
} else {
$clean_input = trim(strip_tags($data));
}
return $clean_input;
}
private function _requestStatus($code) {
$status = array(
100 => 'Continue',
101 => 'Switching Protocols',
200 => 'OK',
201 => 'Created',
202 => 'Accepted',
203 => 'Non-Authoritative Information',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
300 => 'Multiple Choices',
301 => 'Moved Permanently',
302 => 'Found',
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
306 => '(Unused)',
307 => 'Temporary Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Timeout',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Request Entity Too Large',
414 => 'Request-URI Too Long',
415 => 'Unsupported Media Type',
416 => 'Requested Range Not Satisfiable',
417 => 'Expectation Failed',
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Timeout',
505 => 'HTTP Version Not Supported');
return ($status[$code])?$status[$code]:$status[500];
}
}
Und hier ist meine konkrete Klasse code (Probleme auf Linie 8):
<?php
require_once 'API.php';
class MyAPI extends API
{
protected $User;
public function __construct($request, $origin)
{
echo "12";
parent::__construct($request);
//Abstracted out for example
//$APIKey = new Models\APIKey();
//$User = new Models\User();
if (!array_key_exists('apiKey', $this->request)) {
throw new Exception('No API Key provided');
} else if (!$APIKey->verifyKey($this->request['apiKey'], $origin)) {
throw new Exception('Invalid API Key');
} else if (array_key_exists('token', $this->request) && !$User->get('token', $this->request['token'])){
throw new Exception('Invalid User Token');
}
//$this->User = $User;
}
/**
* Example of an Endpoint
*/
protected function example()
{
if ($this->method == 'GET') {
return "Your name is " . $this->User->name;
} else {
return "Only accepts GET requests";
}
}
}
Wie Sie sehen können, die Linie 8 auf die konkrete Klasse (im Konstruktor) wird nie gedruckt. Derzeit bin ich versucht zu machen, meinem Beispiel funktionieren, indem Sie:
www.mysite.com/api/myAPI.php?request=get
Du musst angemeldet sein, um einen Kommentar abzugeben.
Nicht sicher, ob Sie noch brauchen, eine Antwort auf diese, aber ich habe mir gerade die Arbeit, mit ein paar Veränderungen. Es gibt ein paar Probleme mit Ihrem setup. Ersten ist die .htaccess-Datei. Sie haben es auf MyAPI.php aber wenn du die Anleitung zu Lesen, er hat tatsächlich eine Dritte Datei, api.php,, instanziiert die MyAPI Klasse. Die Zeile:
werden sollte:
Sollten Sie nicht versuchen, auf den MyAPI.php Datei direkt. Eher, apache soll api.php, weiterleiten der Anforderung details zusammen. Die Inhalte der api.php Datei (pro CM Seite) sind:
Das zweite problem ist, mit dem URL - Sie sollten seinem Beispiel Folgen, der vorbei an einem Endpunkt (in seinem/meinem Fall " /api/v1/Beispiel). Dadurch wird sowohl der text innerhalb der MyAPI-Konstruktor (wenn Sie verlassen, dass in Ihnen), und die Nachricht von der Beispiel-Endpunkt-Funktion. Für was es Wert ist, ich zog den Schlüssel und die Benutzer-Zeug nur so konnte ich es ausführen. Also mein MyAPI.php die Datei sieht wie folgt aus:
Nahm ich die "einfach starten, verschönern Sie es später" - Ansatz. Viel Glück!
Meiner Meinung nach diese URL ist gegen REST-Prinzipien
Spricht man in der url
request=get
dann der Zweck der Verwendung von HTTP GET stirbt.Einen Erholsamen url sollte so etwas wie
- und eine HTTP-GET-Anfrage an diese url sollte die Arbeit zu tun.