PHP REST ApiダウンロードPHP REST Apiソースコードダウンロード

REST-API

これは、基本的なHTTP認証を使用したPHP REST-APIです。基本的なHTTP認証はエンコードされているが暗号化されていないため、安全な接続（HTTPS）と強力なパスワードを使用することを強くお勧めします。

このAPIを使用して機密データを処理する場合は、自分の責任でそれを行います。

構成
- MySQLデータベースを設定します
- WebServerでPHPビルドを起動します
- 認証
- 資格情報を設定します
サービスを作成します
APIの使用方法
- コレクションを入手してください
- 単一のアイテムを取得します
- 新しいアイテムを作成します
- アイテムを更新します
- アイテムを削除します
拡張された使用法
- 特別なタスクを実行します
HTTPステータスコード
ミドルウェアの追加
著者
ライセンス

構成

MySQLデータベースを設定します

MySQL Serverを設定し、 example_database.sqlを実行します。 settings.phpに関連するmysqlパラメーターを入力します。

WebServerでPHPビルドを起動します

 $ php -S localhost:2400 -t public

認証

デフォルトで認証が有効になっています。 settings.phpで無効にすることができます。

資格情報を設定します

以下の資格情報は現在、 lib/Authenticationミドルウェアでハードコード化されています。適切なロジックを実装するのはあなた次第です。

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

サービスを作成します

servicesディレクトリと特定のバージョンフォルダーにサービスを作成します。サービスは常に抽象クラスのWebサービスから継承されます。これは、すぐに開始するために使用できる基本的なテンプレートです。

 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 );

拡張された使用法

特別なタスクを実行します

サービスは、デフォルトで抽象的なWebServiceクラスからget 、 post 、 put 、 delete 4つの関数を継承します。これらは、データベースでCRUDアクションを実行するのに最適です。しかし、いくつかの特別なタスクを行うべきサービスが必要な場合はどうでしょうか？このような場合、HTTPリクエストメソッドPATCHを使用して、URIのアクションの名前を提供できます。

以下は、2つの数値を掛けるcal固菌サービスの例です。

使用法： 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ステータスコード

APIは、次のステータスコードで応答します。これを好みに変更できます。

成功について：

取得：200 OK
投稿：作成された201
Put：204コンテンツなしまたは202が受け入れられました
削除：205リセットコンテンツ

さもないと：

400悪いリクエスト
401不正
404見つかりません
500内部サーバーエラー

ミドルウェアの追加

以下は、独自のミドルウェアを構築するために使用できるパターンの例です。 Imiddlewareインターフェイスを実装するlibフォルダーにクラスを作成することにより、独自のミドルウェアを作成できます。

 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 );