SimpleAPI

Подключение

composer require digitalstars/simple-api

Как с этим работать

Скрипту обязательно должен приходить параметр module с названием модуля.

• Первый параметр - название модуля

• Остальные параметры - необходимые данные. Если в функции params поставить ? перед параметром, то он считается необязательным

• В массив answer добавляются необходимые данные для фронта. В конце выполнения кейса, библиотека автоматически вызывает деструктор и данные в json формате отправляются фронту.

• если вам удобнее передавать много данный в json формате, то передавайте чистый json вместе с модулем в тело POST запроса

• breake в кейсах ставить не надо, будет и без них нормально работать. Если не нравится инспекции в IDE о пропущенном break, то просто выключите его

• если в answer передать массив, он автоматически конвертируется в json

• OPTIONS запросы игнорируются(полезно если, запросы идут от react/vue/etc)

• есть метод error, в который передается текст. Этот метод завершает скрипт и возвращает на фронт json вида: {"error":"ваш текст"}

• Если не указать хотя бы один из необходимых параметров, то вернется json: {"error":"missed params"}

Пример №1 Обычное использование

GET Запрос:
site.ru/api.php?module=auth&login=admin&password=admin

<?phprequire_once'lib/vendor/autoload.php';
useDigitalStars\SimpleAPI;
$api = newSimpleAPI();
switch ($api->module) {
case'auth':
$data = $api->params(['login', 'password']); //если одного из параметров не будет, скрипт завершится с error$api->answer['auth'] = ($data['login'] == 'admin' && $data['password'] == 'admin');
}

Ответ в json: {"auth" : true}

Пример №2 Использование необязательных параметров

GET Запрос:
site.ru/api.php?module=reg&login=admin&password=admin&name=Fedor

<?phprequire_once'lib/vendor/autoload.php';
useDigitalStars\SimpleAPI;
$api = newSimpleAPI();
switch ($api->module) {
case'auth':
$data = $api->params(['login', 'password', '?name']);
if(isset($data['name']])) {
$api->answer['status'] = true;
$api->answer['info'] = ['login' => $data['login'], 'password' => $data['password']];
} else$api->answer['status'] = false;
}

Ответ в json: {"status" : true, "info":{"login":"admin", "password":"admin"}}

Пример №3 использование функции error

GET Запрос:
site.ru/api.php?module=reg&login=admin&password=admin&age=10

<?phprequire_once'lib/vendor/autoload.php';
useDigitalStars\SimpleAPI;
$api = newSimpleAPI();
switch ($api->module) {
case'auth':
$data = $api->params(['login', 'password', 'age']);
if($data['age'] < 18)
$api->error('Извини, но тебе меньше 18 лет');
}

Ответ в json: {"error" : "Извини, но тебе меньше 18 лет"}

Пример №4 передача json

Как видите, никакого различия в коде по сравнению с 1 примером
GET Запрос:
site.ru/api.php?module=auth&json_data={"login":"123","password":"123"}

<?phprequire_once'lib/vendor/autoload.php';
useDigitalStars\SimpleAPI;
$api = newSimpleAPI();
switch ($api->module) {
case'auth':
$data = $api->params(['login', 'password']);
$api->answer['auth'] = ($data['login'] == 'admin' && $data['password'] == 'admin');
}

Ответ в json: {"auth" : false}

Пример №5 Передача данных через json

POST Запрос:
site.ru/api.php Тело запроса: {"module":"auth", "login":"admin", "password":"admin"}

<?phprequire_once'lib/vendor/autoload.php';
useDigitalStars\SimpleAPI;
$api = newSimpleAPI();
switch ($api->module) {
case'auth':
$data = $api->params(['login', 'password']); //если одного из параметров не будет, скрипт завершится с error$api->answer['auth'] = ($data['login'] == 'admin' && $data['password'] == 'admin');
}

Ответ в json: {"auth" : true}