PHP REST Api скачать - PHP REST Api API Скачать

REST-API

Это PHP REST-API с использованием основной аутентификации HTTP. Поскольку основная аутентификация HTTP кодируется, но не зашифрована, настоятельно рекомендуется использовать безопасное соединение (HTTPS) и сильный пароль.

Если вы используете этот API для обработки конфиденциальных данных, вы делаете это на свой страх и риск.

Конфигурация
- Настройка базы данных MySQL
- Запустите Php Build в WebServer
- Аутентификация
- Установить учетные данные
Создать сервис
Как использовать API
- Получите коллекцию
- Получите один предмет
- Создать новый элемент
- Обновите элемент
- Удалить элемент
Расширенное использование
- Выполнение специальных задач
Http codes
Добавление промежуточного программного обеспечения
Автор
Лицензия

Конфигурация

Настройка базы данных MySQL

Установите сервер MySQL и выполните example_database.sql . Введите связанные параметры MySQL в settings.php .

Запустите Php Build в WebServer

 $ php -S localhost:2400 -t public

Аутентификация

Аутентификация включена по умолчанию. Вы можете отключить его в settings.php .

Установить учетные данные

Приведенные ниже учетные данные в настоящее время жестко закодированы в промежуточном программном обеспечении lib/Authentication . Вы должны реализовать правильную логику.

 $ username = " rest " ;
$ password = " test " ;

Создать сервис

Вы создаете сервисы в каталоге services и в конкретной папке версий. Сервис всегда наследует от абстрактного веб -сервиса класса. Вот базовый шаблон, который вы можете использовать, чтобы быстро начать:

 use RESTapi  Sources  Request ;
use RESTapi  Sources  Response ;
use RESTapi  Sources  WebService ;
use RESTapi  Library  Database ;

class YourService extends WebService {

    private Database | null $ db ;

    public function __construct ()
    {
        $ this -> db = Database:: getInstance ();
    }

    public function get ( Request $ request , Response $ response ): void 
    {
        // Your logic here ...
        $ affectedRows = 12 ;
        $ response -> write ( " JSON " ); // Add a JSON object
        $ response -> addHeader ( " X-Data-Count " , $ affectedRows );
        $ response -> setStatus ( 200 );
    }

    public function post ( Request $ request , Response $ response ): void 
    {
        // Your logic here ...
        $ affectedRows = 12 ;
        $ response -> write ( " JSON " ); // Add a JSON object
        $ response -> addHeader ( " X-Insert-Count " , $ affectedRows );
        $ response -> setStatus ( 201 );
    }

    public function put ( Request $ request , Response $ response ): void 
    {
        // Your logic here ...
        $ affectedRows = 1 ;
        $ response -> write ( " JSON " ); // Add a JSON object
        $ response -> addHeader ( " X-Update-Count " , $ affectedRows );
        $ response -> setStatus ( 204 );
    }

    public function delete ( Request $ request , Response $ response ): void 
    {
        // Your logic here ...
        $ affectedRows = 1 ;
        $ response -> write ( " JSON " ); // Add a JSON object
        $ response -> addHeader ( " X-Delete-Count " , $ affectedRows );
        $ response -> setStatus ( 205 );
    }
}

Работа с базой данных:
Пожалуйста, проверьте службу Users , чтобы узнать и понять, как создавать запросы для выполнения операций CRUD.

Как использовать API

Получите коллекцию

Использование: GET domain.tld/[version]/[service]

 $ ch = curl_init ( " http://localhost:2400/v1/Users/ " );
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Получите один предмет

Использование: GET domain.tld/[version]/[service]/[id]

 $ ch = curl_init ( " http://localhost:2400/v1/Users/3 " );
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Создать новый элемент

Использование: POST domain.tld/[version]/[service]

 $ body = [
    " name " => " Greta Garbo " ,
    " age " => " 93 " ,
    " city " => " Hollywood " ,
    " country " => " California "
];
$ ch = curl_init ( " http://localhost:2400/v1/Users " );
curl_setopt ( $ ch , CURLOPT_POST , true );
curl_setopt ( $ ch , CURLOPT_POSTFIELDS , http_build_query ( $ body ));
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Обновите элемент

Использование: PUT domain.tld/[version]/[service]/[id]

 $ body = [
    " name " => " John Rambo " ,
    " age " => " 42 " ,
    " city " => " Seattle " ,
    " country " => " Washington "
];
$ ch = curl_init ( " http://localhost:2400/v1/Users/4 " );
curl_setopt ( $ ch , CURLOPT_CUSTOMREQUEST , " PUT " );
curl_setopt ( $ ch , CURLOPT_POSTFIELDS , http_build_query ( $ body ));
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Удалить элемент

Использование: DELETE domain.tld/[version]/[service]/[id]

 $ ch = curl_init ( " http://localhost:2400/v1/Users/1 " );
curl_setopt ( $ ch , CURLOPT_CUSTOMREQUEST , " DELETE " );
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Расширенное использование

Выполнение специальных задач

Сервис наследует четыре функции post get put и delete из класса Abstract Webservice. Они идеально подходят для выполнения CRUD -действий в базе данных. Но что, если вам нужна услуга, которая должна выполнять некоторые специальные задачи? В таком случае вы можете использовать PATCH HTTP -запроса и предоставить имя действия в URI.

Ниже приведен пример службы калукуляции, которая умножает два числа:

Использование: PATCH domain.tld/[version]/[service]/[action]

 $ ch = curl_init ( " http://localhost:2400/v1/Calculator/multiply " );
$ body = [
    " a " => 12 ,
    " b " => 2.5
];
$ ch = curl_init ( $ url );
curl_setopt ( $ ch , CURLOPT_CUSTOMREQUEST , " PATCH " );
curl_setopt ( $ ch , CURLOPT_POSTFIELDS , http_build_query ( $ body ));
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Http codes

API отвечает следующими кодами статуса. Вы можете изменить это по своему вкусу:

Об успехе:

Получить: 200 ОК
Пост: 201 создан
Поместите: 204 Нет контента или 202
Удалить: 205 сбросить контент

В противном случае:

400 Плохая просьба
401 несанкционирован
404 не найден
500 Ошибка внутреннего сервера

Добавление промежуточного программного обеспечения

Ниже приведен пример шаблона, который вы можете использовать для создания собственного промежуточного программного обеспечения. Вы можете создать свое собственное промежуточное программное обеспечение, создав класс в папке lib , который реализует интерфейс Imiddleware :

 class YourMiddleware implements IMiddleware {

    public function handle ( Request $ request , Response $ response ): void {}
}

Чтобы ввести промежуточное программное обеспечение в другое промежуточное программное обеспечение. Используйте конструктор этого промежуточного программного обеспечения:

 class YourMiddleware implements IMiddleware {

    public function __construct ( private IMiddleware $ anotherMiddleware ) {}

    public function handle ( Request $ request , Response $ response ): void
    {
        // 1. Add your logic ...

        // 2. Handle Middleware ...
        $ this -> anotherMiddleware -> handle ( $ request , $ response );

        // 3. Do something afterwards ...
    }
}

$ anotherMiddleware = new AnotherMiddleware ();
$ yourMiddleware = new YourMiddleware ( $ anotherMiddleware );
$ yourMiddleware -> handle ( $ request , $ response );