Как сделать rest api на php

Пример простого REST API на PHP.

В данной заметке пример самого простого REST API на PHP без использования какого-либо фреймворка и других средств. Целью есть предоставить общую картину — как это все работает.
Недавно я уже опубликовал статью, в которой описан процесс создания REST API для проекта на Yii2.

Т.к. никакие фреймворки с маршрутизаторами в примере использоваться не будут, нужно начать с перенаправления всех запросов на «точку входа» — файл index.php. Для сервера на Apache это можно сделать в файле .htaccess который должен располагаться в корне проекта:

Options +FollowSymLinks IndexIgnore */* RewriteEngine on # Перенаправление с ДОМЕН на ДОМЕН/api RewriteCond % ^/$ RewriteRule ^(.*)$ /api/$1 [R=301] #Если URI начинается с api/ то перенаправлять все запросы на index.php RewriteEngine On RewriteCond % !-f RewriteCond % !-d RewriteRule ^api/(.*)$ /index.php

Согласно правил, ссылка должна начинаться на /api и ,например, для API работающего с таблицей users должна иметь такой вид:
ДОМЕН/api/users

Пример файла index.php

run(); > catch (Exception $e) < echo json_encode(Array('error' =>$e->getMessage())); >

Как видно из кода — будем работать с объектом usersApi, т.е. с пользователями (таблица users). Т.к. для простоты примера я не использую тут Composer или другой механизм для автозагрузки классов, просто подключим файл класса с помощью

require_once 'UsersApi.php';

Кроме пользователей, может потребоваться сделать api и для других сущностей, поэтому все классы различных API должны иметь один общий костяк, который будет определять метод запроса, действие для выполнения и тд. Создаем файл Api.php c абстрактным классом Api:

requestUri = explode('/', trim($_SERVER['REQUEST_URI'],'/')); $this->requestParams = $_REQUEST; //Определение метода запроса $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"); >> > public function run() < //Первые 2 элемента массива URI должны быть "api" и название таблицы if(array_shift($this->requestUri) !== 'api' || array_shift($this->requestUri) !== $this->apiName) < throw new RuntimeException('API Not Found', 404); >//Определение действия для обработки $this->action = $this->getAction(); //Если метод(действие) определен в дочернем классе API if (method_exists($this, $this->action)) < return $this->action>(); > else < throw new RuntimeException('Invalid Method', 405); >> protected function response($data, $status = 500) < header("HTTP/1.1 " . $status . " " . $this->requestStatus($status)); return json_encode($data); > private function requestStatus($code) < $status = array( 200 =>'OK', 404 => 'Not Found', 405 => 'Method Not Allowed', 500 => 'Internal Server Error', ); return ($status[$code])?$status[$code]:$status[500]; > protected function getAction() < $method = $this->method; switch ($method) < case 'GET': if($this->requestUri) < return 'viewAction'; >else < return 'indexAction'; >break; case 'POST': return 'createAction'; break; case 'PUT': return 'updateAction'; break; case 'DELETE': return 'deleteAction'; break; default: return null; > > abstract protected function indexAction(); abstract protected function viewAction(); abstract protected function createAction(); abstract protected function updateAction(); abstract protected function deleteAction(); >

Осталось реализовать абстрактные методы и свойство $apiName, которое уникально для каждого отдельного API. Для этого создаем файл UsersApi.php:

getConnect(); $users = Users::getAll($db); if($users)< return $this->response($users, 200); > return $this->response('Data not found', 404); > /** * Метод GET * Просмотр отдельной записи (по id) * http://ДОМЕН/users/1 * @return string */ public function viewAction() < //id должен быть первым параметром после /users/x $id = array_shift($this->requestUri); if($id)< $db = (new Db())->getConnect(); $user = Users::getById($db, $id); if($user)< return $this->response($user, 200); > > return $this->response('Data not found', 404); > /** * Метод POST * Создание новой записи * http://ДОМЕН/users + параметры запроса name, email * @return string */ public function createAction() < $name = $this->requestParams['name'] ?? ''; $email = $this->requestParams['email'] ?? ''; if($name && $email)< $db = (new Db())->getConnect(); $user = new Users($db, [ 'name' => $name, 'email' => $email ]); if($user = $user->saveNew())< return $this->response('Data saved.', 200); > > return $this->response("Saving error", 500); > /** * Метод PUT * Обновление отдельной записи (по ее id) * http://ДОМЕН/users/1 + параметры запроса name, email * @return string */ public function updateAction() < $parse_url = parse_url($this->requestUri[0]); $userId = $parse_url['path'] ?? null; $db = (new Db())->getConnect(); if(!$userId || !Users::getById($db, $userId))< return $this->response("User with not found", 404); > $name = $this->requestParams['name'] ?? ''; $email = $this->requestParams['email'] ?? ''; if($name && $email)< if($user = Users::update($db, $userId, $name, $email))< return $this->response('Data updated.', 200); > > return $this->response("Update error", 400); > /** * Метод DELETE * Удаление отдельной записи (по ее id) * http://ДОМЕН/users/1 * @return string */ public function deleteAction() < $parse_url = parse_url($this->requestUri[0]); $userId = $parse_url['path'] ?? null; $db = (new Db())->getConnect(); if(!$userId || !Users::getById($db, $userId))< return $this->response("User with not found", 404); > if(Users::deleteById($db, $userId))< return $this->response('Data deleted.', 200); > return $this->response("Delete error", 500); > >

Методы связанные с базой данных и получением данных из нее просто для примера.

Автор: Сергей Дата публикации: 05.10.2018

• Использование YouTube Data API для своего WEB-сервиса. Выборка нужных видеозаписей, получение информации.
• Определение страны и города посетителя по его IP. Расширение GeoIP.
• Установка, настройка и базовое использование фреймворка для тестирования «Codeception».
• Основы PHPUnit — 1 часть.
• Использование событий в PHP.

Пример простого создания REST API на PHP

В данной статье рассказывается пример простого REST API реализация которого на PHP без использования каких-либо фреймворков. Из-за того, что никак фреймворки применяться не будут, необходимо начать с того, что перенаправления всех запросов на точку входа, это index.php . Сервер где используется Apache , это можно реализовать в файле htaccess который должен находится в корне проекта:

Options +FollowSymLinks IndexIgnore */* RewriteEngine on # Перенаправление с domain.by на domain.by/api RewriteCond % ^/$ RewriteRule ^(.*)$ /api/$1 [R=301] #Если адрес начинается с api/ , то перенаправлять все запросы на index.php RewriteEngine On RewriteCond % !-f RewriteCond % !-d RewriteRule ^api/(.*)$ /index.php 

Исходя из правил, ссылка должна начинаться с /api , допустим, для API работающего с таблицей people должна иметь такой вид: domain.by/api/people Пример файла index.php :

require_once 'PeopleApi.php'; try < $api = new usersApi(); echo $api->run(); > catch (Exception $e) < echo json_encode(Array('error' =>$e->getMessage())); > 

Как видно из примера, будет идти работа с объектом peopleApi , в примере показано подключение файла c классом непосредственно через require_once .

require_once 'PeopleApi.php'; 

Кроме людей еще возможно нужно будет сделать API и по другим сущностям, и поэтому все классы различных API должны иметь один общий костяк, который будет определять метод запроса, действие для выполнения и так далее. Создаем файл API с абстрактным классом Api :

abstract class Api < public $apiName = ''; //people protected $method = ''; //GET|POST|PUT|DELETE public $requestUri = []; public $requestParams = []; protected $action = ''; //Название метода для выполнения public function __construct() < header("Access-Control-Allow-Orgin: *"); header("Access-Control-Allow-Methods: *"); header("Content-Type: application/json"); //Массив GET параметров разделенных / $this->requestUri = explode('/', trim($_SERVER['REQUEST_URI'],'/')); $this->requestParams = $_REQUEST; //Определение метода запроса $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"); >> > public function run() < //Первые 2 элемента массива URI должны быть "api" и название таблицы if(array_shift($this->requestUri) !== 'api' || array_shift($this->requestUri) !== $this->apiName) < throw new RuntimeException('API Not Found', 404); >//Определение действия для обработки $this->action = $this->getAction(); //Если метод(действие) определен в дочернем классе API if (method_exists($this, $this->action)) < return $this->action>(); > else < throw new RuntimeException('Invalid Method', 405); >> protected function response($data, $status = 500) < header("HTTP/1.1 " . $status . " " . $this->requestStatus($status)); return json_encode($data); > private function requestStatus($code) < $status = array( 200 =>'OK', 404 => 'Not Found', 405 => 'Method Not Allowed', 500 => 'Internal Server Error', ); return ($status[$code])?$status[$code]:$status[500]; > protected function getAction() < $method = $this->method; switch ($method) < case 'GET': if($this->requestUri) < return 'viewAction'; >else < return 'indexAction'; >break; case 'POST': return 'createAction'; break; case 'PUT': return 'updateAction'; break; case 'DELETE': return 'deleteAction'; break; default: return null; > > abstract protected function indexAction(); abstract protected function viewAction(); abstract protected function createAction(); abstract protected function updateAction(); abstract protected function deleteAction(); > 

Напоследок осталось реализовать абстрактные методы и свойство $apiName , которые будут уникальны для каждого отдельного API . Для примера создаем файл PeopleApi.php :

require_once 'Api.php'; require_once 'Db.php'; require_once 'People.php'; class PeopleApi extends Api < public $apiName = 'people'; /** * Метод GET * Вывод списка всех записей * https://domain.by/people * @return string */ public function indexAction() < $db = (new Db())->getConnect(); $people = People::getAll($db); if($people)< return $this->response($people, 200); > return $this->response('Data not found', 404); > /** * Метод GET * Просмотр отдельной записи (по id) * https://domain.by/people/1 * @return string */ public function viewAction() < //id должен быть первым параметром после /people/x $id = array_shift($this->requestUri); if($id)< $db = (new Db())->getConnect(); $user = People::getById($db, $id); if($user)< return $this->response($user, 200); > > return $this->response('Data not found', 404); > /** * Метод POST * Создание новой записи * https://domain.by/people + параметры запроса name, email * @return string */ public function createAction() < $name = $this->requestParams['name'] ?? ''; $email = $this->requestParams['email'] ?? ''; if($name && $email)< $db = (new Db())->getConnect(); $user = new People($db, [ 'name' => $name, 'email' => $email ]); if($user = $user->saveNew())< return $this->response('Data saved.', 200); > > return $this->response("Saving error", 500); > /** * Метод PUT * Обновление отдельной записи (по ее id) * https://domain.by/people/1 + параметры запроса name, email * @return string */ public function updateAction() < $parse_url = parse_url($this->requestUri[0]); $userId = $parse_url['path'] ?? null; $db = (new Db())->getConnect(); if(!$userId || !People::getById($db, $userId))< return $this->response("User with not found", 404); > $name = $this->requestParams['name'] ?? ''; $email = $this->requestParams['email'] ?? ''; if($name && $email)< if($user = People::update($db, $userId, $name, $email))< return $this->response('Data updated.', 200); > > return $this->response("Update error", 400); > /** * Метод DELETE * Удаление отдельной записи (по ее id) * https://domain.by/people/1 * @return string */ public function deleteAction() < $parse_url = parse_url($this->requestUri[0]); $userId = $parse_url['path'] ?? null; $db = (new Db())->getConnect(); if(!$userId || !People::getById($db, $userId))< return $this->response("User with not found", 404); > if(People::deleteById($db, $userId))< return $this->response('Data deleted.', 200); > return $this->response("Delete error", 500); > > 

Простой RESTful-сервис на нативном PHP

Я не знаю ни одного php-фреймворка. Это печально и стыдно, но законом пока не запрещено. А при этом поиграться с REST API хочется. Проблема в том, что php по умолчанию поддерживает только $_GET и $_POST. А для RESTful-сервиса надобно уметь работать еще и с PUT, DELETE и PATCH. И не очень очевидно, как культурно обработать множество запросов вида GET http://site.ru/users, DELETE http://site.ru/goods/5 и прочего непотребства. Как завернуть все подобные запросы в единую точку, универсально разобрать их на части и запустить нужный код для обработки данных?

Почти любой php-фреймворк умеет делать это из коробки. Например, Laravel, где роутинг реализован понятно и просто. Но что если нам не нужно прямо сейчас заниматься изучением новой большой темы, а хочется просто быстро завести проект с поддержкой REST API? Об этом и пойдет речь в статье.

Что должен уметь наш RESTful-сервис?

1. Поддерживать все 5 основных типов запросов: GET, POST, PUT, PATCH, DELETE.
2. Разруливать разнообразные маршруты вида
POST /goods
PUT /goods/
GET /users//info
и прочие сколь угодно длинные цепочки.

RewriteEngine On RewriteCond % !-f RewriteRule ^(.+)$ index.php?q=$1 [L,QSA]

// Определяем метод запроса $method = $_SERVER['REQUEST_METHOD'];

// Получаем данные из тела запроса $formData = getFormData($method);

// Получение данных из тела запроса function getFormData($method) < // GET или POST: данные возвращаем как есть if ($method === 'GET') return $_GET; if ($method === 'POST') return $_POST; // PUT, PATCH или DELETE $data = array(); $exploded = explode('&', file_get_contents('php://input')); foreach($exploded as $pair) < $item = explode('=', $pair); if (count($item) == 2) < $data[urldecode($item[0])] = urldecode($item[1]); >> return $data; >

// Разбираем url $url = (isset($_GET['q'])) ? $_GET['q'] : ''; $url = rtrim($url, '/'); $urls = explode('/', $url);

$urls = array('goods', 'page', '2', 'limit', '10', 'sort', 'price_asc');

// Определяем роутер и url data $router = $urls[0]; $urlData = array_slice($urls, 1); // Подключаем файл-роутер и запускаем главную функцию include_once 'routers/' . $router . '.php'; route($method, $urlData, $formData);

// Роутер function route($method, $urlData, $formData) < // Получение информации о товаре // GET /goods/if ($method === 'GET' && count($urlData) === 1) < // Получаем id товара $goodId = $urlData[0]; // Вытаскиваем товар из базы. // Выводим ответ клиенту echo json_encode(array( 'method' =>'GET', 'id' => $goodId, 'good' => 'phone', 'price' => 10000 )); return; > // Возвращаем ошибку header('HTTP/1.0 400 Bad Request'); echo json_encode(array( 'error' => 'Bad Request' )); >

$.ajax(>)

curl -X GET https://webdevkin.ru/examples/rest/goods/10 -i

// Возвращаем ошибку header('HTTP/1.0 400 Bad Request'); echo json_encode(array( 'error' => 'Bad Request' ));

// Добавление нового товара // POST /goods if ($method === 'POST' && empty($urlData)) < // Добавляем товар в базу. // Выводим ответ клиенту echo json_encode(array( 'method' =>'POST', 'id' => rand(1, 100), 'formData' => $formData )); return; >

$.ajax(, dataType: 'json', success: function(response)>)

curl -X POST https://webdevkin.ru/examples/rest/goods/ --data "good=notebook&price=20000" -i

// Обновление всех данных товара // PUT /goods/ if ($method === 'PUT' && count($urlData) === 1) < // Получаем id товара $goodId = $urlData[0]; // Обновляем все поля товара в базе. // Выводим ответ клиенту echo json_encode(array( 'method' =>'PUT', 'id' => $goodId, 'formData' => $formData )); return; >

$.ajax(, dataType: 'json', success: function(response)>)

curl -X PUT https://webdevkin.ru/examples/rest/goods/15 --data "good=notebook&price=20000" -i

// Частичное обновление данных товара // PATCH /goods/ if ($method === 'PATCH' && count($urlData) === 1) < // Получаем id товара $goodId = $urlData[0]; // Обновляем только указанные поля товара в базе. // Выводим ответ клиенту echo json_encode(array( 'method' =>'PATCH', 'id' => $goodId, 'formData' => $formData )); return; >

$.ajax(, dataType: 'json', success: function(response)>)

curl -X PATCH https://webdevkin.ru/examples/rest/goods/15 --data "price=25000" -i

// Удаление товара // DELETE /goods/ if ($method === 'DELETE' && count($urlData) === 1) < // Получаем id товара $goodId = $urlData[0]; // Удаляем товар из базы. // Выводим ответ клиенту echo json_encode(array( 'method' =>'DELETE', 'id' => $goodId )); return; >

$.ajax(>)

curl -X DELETE https://webdevkin.ru/examples/rest/goods/20 -i

// Роутер function route($method, $urlData, $formData) < // Получение всей информации о пользователе // GET /users/if ($method === 'GET' && count($urlData) === 1) < // Получаем id товара $userId = $urlData[0]; // Вытаскиваем все данные о пользователе из базы. // Выводим ответ клиенту echo json_encode(array( 'method' =>'GET', 'id' => $userId, 'info' => array( 'email' => 'webdevkin@gmail.com', 'name' => 'Webdevkin' ), 'orders' => array( array( 'orderId' => 5, 'summa' => 2000, 'orderDate' => '12.01.2017' ), array( 'orderId' => 8, 'summa' => 5000, 'orderDate' => '03.02.2017' ) ) )); return; > // Возвращаем ошибку header('HTTP/1.0 400 Bad Request'); echo json_encode(array( 'error' => 'Bad Request' )); >

$.ajax(>)

curl -X GET https://webdevkin.ru/examples/rest/users/5 -i

// Получение общей информации о пользователе // GET /users//info if ($method === 'GET' && count($urlData) === 2 && $urlData[1] === 'info') < // Получаем id товара $userId = $urlData[0]; // Вытаскиваем общие данные о пользователе из базы. // Выводим ответ клиенту echo json_encode(array( 'method' =>'GET', 'id' => $userId, 'info' => array( 'email' => 'webdevkin@gmail.com', 'name' => 'Webdevkin' ) )); return; >

$.ajax(>)

curl -X GET https://webdevkin.ru/examples/rest/users/5/info -i

// Получение заказов пользователя // GET /users//orders if ($method === 'GET' && count($urlData) === 2 && $urlData[1] === 'orders') < // Получаем id товара $userId = $urlData[0]; // Вытаскиваем данные о заказах пользователя из базы. // Выводим ответ клиенту echo json_encode(array( 'method' =>'GET', 'id' => $userId, 'orders' => array( array( 'orderId' => 5, 'summa' => 2000, 'orderDate' => '12.01.2017' ), array( 'orderId' => 8, 'summa' => 5000, 'orderDate' => '03.02.2017' ) ) )); return; >

$.ajax(>)

curl -X GET https://webdevkin.ru/examples/rest/users/5/orders -i

 RewriteEngine On RewriteCond % !-f RewriteCond % !-d RewriteRule api/v1/(.*)$ api/v1/api.php?request=$1 [QSA,NC,L] RewriteEngine On RewriteCond % !-f RewriteCond % !-d RewriteRule api/v1/(.*)$ api/v1/api.php?request=$1 [QSA,NC,L] 

abstract class API < /** * Property: method * GET, POST, PUT, 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: //// * or // */ 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: *"); header("Access-Control-Allow-Methods: *"); 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; > > public function processAPI() < if (method_exists($this, $this->endpoint)) < return $this->_response($this->endpoint>($this->args)); > return $this->_response("No Endpoint: $this->endpoint", 404); > 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( 200 =>'OK', 404 => 'Not Found', 405 => 'Method Not Allowed', 500 => 'Internal Server Error', ); return ($status[$code])?$status[$code]:$status[500]; > >

require_once 'API.class.php'; class MyAPI extends API < protected $User; public function __construct($request, $origin) < 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"; >> >

// Requests from the same server don't have a HTTP_ORIGIN header if (!array_key_exists('HTTP_ORIGIN', $_SERVER)) < $_SERVER['HTTP_ORIGIN'] = $_SERVER['SERVER_NAME']; >try < $API = new MyAPI($_REQUEST['request'], $_SERVER['HTTP_ORIGIN']); echo $API->processAPI(); > catch (Exception $e) < echo json_encode(Array('error' =>$e->getMessage())); >