Как сделать свой REST API?

Question

[Danya Kozlovskiy]

Здравствуйте, надо сделать свой сервис API на PHP, у которого будет функционал доступа к данным в стиле REST. Используя базу данных.

Что бы работало вот так:

GET /api/games/ - список игрушек

GET /api/game/12345/ – информация о игрушке

POST /api/games/ + JSON – добавить новую игрушку

PUT /api/games/12345/ + JSON – обновить существующую игрушку

DELETE /api/games/12345/ – удалить игрушку

Данные возвращаются в JSON, с использованием как можно большего количества HTTP-статусов. Можно использовать готовые решения через composer.

Как сделать описанное мною выше, умею только получать JSON с помощью ajax, а вот как сделать свою, понятия не имею от слова совсем. Желательно какой-нибудь простенький пример с объяснениями или ссылочку где это всё простенько объясняется, опять же с примерами где все максимально понятно и просто или на вашем примере Т.к. в этом деле новичок.

Comments

[Владислав Лысков]

Если написать в гугле rest api php ответов совсем нету?

[Alams Stoyne]

Я помогу Если вас в Гугле забанили

[Danya Kozlovskiy]

Владислав Лысков, есть, но там либо поверхностные знания, либо просто код опять же с поверхностным объяснением не вдаваясь в базу по типу: что, зачем, что как делает, для чего делает и т.п.

[Alams Stoyne]

morto, Есть 3 способа:

1. Обучиться самостоятельно
   
2. Пойти обучаться на курсы
   
3. Заказать такую штуку
   

Здесь не обучают тут помогают советом !

[Danya Kozlovskiy]

Alams Stoyne, спасибо большое, сразу разбанили, я был здесь, но просто скопировать вставить для меня не очень подходит, а все комментарии, что там написаны не достаточны мне для понимания, что происходит.

Комментарий под этой статьей что вы мне отправили, который описывает в чем моя проблема:

*Вот это статься, отличное руководство как создать REST, единственное как новичку трудно понять а зачем это все..честно говоря уже 3 дня перекапываю инет в поисках нормальной статьи что такое rest API и нафига оно нужно, одна проблема где то пишут что это такое и какие у него преимущества поверхностно, типа ну так проще жить и бла бла бла, в других сразу приходят к суровой реализации не объясняя что и за чем делается. Ваша пока лучшая в этом плане, хотя бы понятно что делается, правда не понятно что в конце должно получиться...и почему это делается именно так а не иначе. Например простой вопрос, зачем пишутся header, почти в каждом файле. Ответ в инете адекватный и простыми словами задолбаешься искать...*

[Alams Stoyne]

morto, Тогда может начать с основ изучения языка PHP узнать чем отличает $_GET от $_POST и что такое $_REQUEST а не замахиваться на ТЗ для получения работы абсолютно плавая в вопросе.

Answer 1

[Fedor Vlasenko]

index.php

<?php
# Author - Fedor Vlasenko, [e-mail]
define('METHOD', $_SERVER['REQUEST_METHOD']);
define('URI', parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH));

function router($url, ...$args)
{
    (empty($args[1]) || false !== strpos(METHOD, $args[0]))
    && (URI === $url || preg_match('#^' . $url . '$#iu', URI, $match))
    && die(call_user_func_array(end($args), $match ?? []));
}

router('/api/games', 'GET', function () {
    echo 'список игрушек';
});

router('/api/game/(\d+)', 'GET', function (...$args) {
    echo 'информация о игрушке: ', $args[1];
});

router('/api/games', 'POST', function () {
    echo 'добавить новую игрушку';
});

router('/api/games/(\d+)', 'PUT', function (...$args) {
    echo 'обновить существующую игрушку: ', $args[1];
});

router('/api/games/(\d+)', 'DELETE', function (...$args) {
    echo ' удалить игрушку: ', $args[1];
});

header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
echo '404';

далее в консоли запускаем встроенный php сервер
php -S localhost:8000 index.php
тестируем и наслаждаемся :-)

Comments

[Danya Kozlovskiy]

Fedor Vlasenko, т.е. теперь мне нужно засунуть по этим папкам json файлы и вместо echo, описать, что делать с этим json файлом? И как выполнить запросы PUT, DELETE и POST из браузера или это нужно уже PHP использовать?

[Fedor Vlasenko]

ничего никуда засовывать не надо
есть несколько вариантов как вам прийдет json
в $_POST или в body
$body = file_get_contents('php://input');
отправляйте с помощью postman для изучения
и swager сразу для документирования
в нормальных ide от Jetbrains http клиент встроен
в пример delete.http
DELETE http://localhost:8000/api/games/12

Answer 2

[Кирилл Горелов]

www.slimframework.com готовое решение.
Ставиться за 5 минут.

Comments

[posters]

Есть еще Guzzle, PHP HTTP client. Вроде, не хуже.
А так, под запросы автора любой микрофреймворк подойдет.

[Кирилл Горелов]

posters, Вообще не спорю

Answer 3

[Владимир Коротенко]

GET /api/games/
POST /api/games/12345
PUT /api/games/12345/
DELETE /api/games/12345/

папки и файлы
var/www/html/config.php - конфиг базы и прочее
var/www/html/api/games/index.php - ваше api

<?php
$method = $_SERVER['REQUEST_METHOD'];
$request = explode("/", substr(@$_SERVER['PATH_INFO'], 1));

switch ($method) {
  case 'PUT':
    do_something_with_put($request);  
    break;
  case 'POST':
    do_something_with_post($request);  
    break;
  case 'GET':
    do_something_with_get($request);  
    break;
  default:
    handle_error($request);  
    break;
}

Comments

[edward_freedom]

зачем свитч использовать? Нравится брейки писать, чем иф не угодил?

[Владимир Коротенко]

edward_freedom, это вкусовщина и возможно сила привычки

Answer 4

[Ibishka]

<?php
// Headers
header('Access-Control-Allow-Origin: http://localhost:3000');
header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE');
header('Access-Control-Allow-Headers: *');
header('Content-Type: application/json');
// Connect to db
$connect = mysqli_connect('localhost', 'root', 'root', 'f-mania');
// If connect error
if (!$connect) {
  echo mysqli_connect_error();
  die();
}
// Split url into array
$params = explode('/', $_GET['url']);

if ($_SERVER['REQUEST_METHOD'] == 'GET') {
  if ($params[0] == 'account') {
   // ...
  }
} elseif ($_SERVER['REQUEST_METHOD'] == 'POST') {
  if ($params[0] == 'account') {
    if ($params[1] == 'login') {
   // ...
    } elseif ($params[1] == 'recover') {
   // ...
    } elseif ($params[1] == 'reset') {
   // ...
    } elseif ($params[1] == 'register') {
   // ...
    }
  }
} elseif ($_SERVER['REQUEST_METHOD'] == 'PUT') {
   // ...
} elseif ($_SERVER['REQUEST_METHOD'] == 'DELETE') {
   // ...
}

.htaccess

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-F
RewriteRule ^(.+)$ index.php?url=$1 [L,QSA]

Answer 5

[d'Ivan]

Проще всего начать с автогенерации кода по спецификации OpenAPI (swagger).
Редактор спецификации онлайн: https://editor.swagger.io/

Answer 6

[tempick]

Как вариант - использовать Yii2 - с помощью него легко делать REST API

Comments

[Сергей delphinpro]

rest легко можно делать с любым фреймом.