PHP で API インターフェースをより適切に呼び出す方法

この記事では、PHP で API インターフェイスを呼び出すより良い方法を紹介します。一定の参考値があるので、困っている友達が参考になれば幸いです。

API インターフェイスは、さまざまなシナリオで非常に一般的に使用されています。API インターフェイスは通常、PHP バックグラウンドで呼び出され、さまざまな機能はもちろんのこと、Curl ライブラリを通じてカプセル化する必要があります。ただし、さまざまな API インターフェイス プラットフォームの appKey や appSecret などのパラメータによって混乱するため、統一的に呼び出すことはできません。 ThinkPHP が公式に作成した ThinkAPI サービスは、まさに PHP インターフェース呼び出しにおけるさまざまな厄介な問題を解決するためのものです。

ThinkAPI 統合 API インターフェース サービスは、公式共同パートナーによってカプセル化されたインターフェース呼び出しサービスと SDK のセットであり、ThinkPHP 開発者が公式およびサードパーティが提供するさまざまな API をより便利かつ低コストで呼び出せるように設計されています。開発者エコシステムをより適切に構築するためのインターフェイスとサービス。

API インターフェイスは、ThinkAPI が提供する SDK 関数を使用して、よりエレガントな方法で呼び出すことができます。まず、プロジェクトに think-api ライブラリをインストールする必要があります (任意の PHP5.6 プロジェクトに適用できます。フレームワーク要件）。

composer require topthink/think-api

その後、クエリを実行してデータを返すために必要なインターフェイスを呼び出すことができます。これは、ThinkAPI のすべての API インターフェイスをサポートしています。例として、ID カードが属する地域をクエリするためのインターフェイスを取り上げます:

use thinkapiClient;

$client = new Client("appCode");

$result = $client->idcardIndex()
    ->withCardno('身份证号码')
    ->request();

idcardIndex メソッドが呼び出されます ID カード所有権クエリ インターフェイスの withCardno メソッドは、cardno パラメータが渡されることを示します。さらに多くのパラメータを渡す必要がある場合は、チェーンでさらに多くのメソッドを呼び出すことができます。最後に、実際の呼び出しは次のようになります。 request メソッドを通じて行われ、データが返されます。 IDE を使用する場合は、インターフェイス メソッド名とパラメーター メソッド名を覚えておく必要はありません。これらは自動的に要求されます。

ThinkAPI のすべての API 呼び出しサービスは、インターフェイス呼び出しの ID 認証に使用される appCode 値を設定する必要があります (取得するにはアカウントを登録するだけです)。複数回呼び出す必要がある場合は、プロジェクト内でヘルパー関数をカプセル化することをお勧めします。例:

use thinkapiClient;

/**
 * API接口调用助手函数
 * @return Client
 */
function api(): Client
{
    return new Client('yourAppCode');
}

// 调用示例
$result = api()->idcardIndex()
    ->withCardno('身份证号码')
    ->request();

すべてのインターフェイス サービスとメソッドは、IDE の自動プロンプトと補完をサポートしています (必ず注意してください)メソッドのケースは一貫している必要があります)、返されるデータはすべて JSON 形式であるため、基本的にインターフェイス開発作業を完了するためにドキュメントは必要ありません。 API インターフェイス呼び出しでよくある問題の一部は、システム メソッドのカプセル化によって回避できます。インターフェイスで GET を使用するか POST を使用するかを気にする必要はなく、すべてシステムによって自動的に処理されます。

SDK は、すべてのインターフェイスとパラメーターを独立したメソッドにカプセル化します。クラス メソッドを呼び出すのと同じように、公式にサポートされている API インターフェイスを呼び出すことができ、各インターフェイスの詳細を覚える必要はありません。パラメーターとは何ですか?

お使いの環境が Composer をサポートしていない場合、または PHP バージョンが低すぎる場合は、インターフェイスを呼び出すために Curl ライブラリを自分でカプセル化する必要がある場合があります。 ThinkAPI インターフェースのドキュメントでは、インターフェース・アドレスを直接呼び出す方法と、SDK を使用して呼び出す方法の 2 つの呼び出し方法が提供されています。

詳しい使用方法については、https://docs.topthink.com/think-api

推奨学習: php ビデオ チュートリアル

以上がPHP で API インターフェースをより適切に呼び出す方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。