PHP はオープンソース API 管理プラットフォーム システムを実装します

PHP はオープン ソース API 管理プラットフォーム システムを実装します

Web サービスの継続的な開発により、Web API は Web 2.0 時代の重要な部分になりました。 Web APIはアプリケーションに多くの機能やインターフェースを提供しており、さまざまなアプリケーションをより簡単かつ便利に構築できます。ただし、多数の API の管理と保守は頭痛の種となる場合があります。したがって、オープンソースの API 管理プラットフォーム システムが非常に必要です。

この記事では、PHP を使用してオープンソース API 管理プラットフォーム システムを実装する方法を紹介します。

環境の準備

オープンソース API 管理プラットフォーム システムを実行するには、次の環境が必要です:

1. PHP
2. MySQL
3. Apache/Nginx

もちろん、Apache や Nginx の代わりに他の Web サーバーを使用することもできます。

システム フレームワーク

PHP フレームワーク Laravel を使用して、オープン ソース API 管理プラットフォーム システムを構築します。 Laravel は、美しく設計され、使用と保守が簡単な人気の PHP フレームワークです。

Laravel のインストール

次のコマンドを使用して Laravel の最新バージョンをインストールします:

composer create-project --prefer-dist laravel/laravel api-manager

このコマンドは、現在のディレクトリに api-manager という新しいプロジェクトを作成し、Laravel とその関連依存関係を自動的にインストールします。

データベースの作成

MySQL でデータベースを作成し、それをアプリケーションに関連付ける必要があります。次のコマンドを使用して、MySQL に新しいデータベースを作成できます:

CREATE DATABASE api_manager;

データベース構成情報の更新

api-manager の .env ファイルを開きます。プロジェクトと変更 次の情報が MySQL 接続情報で更新されます:

DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=api_manager
DB_USERNAME=root
DB_PASSWORD=

Swagger のインストールと構成

#Swagger は、API ドキュメントをより適切に整理および表示するのに役立つ人気のある API ドキュメント ツールです。次のコマンドを使用して Swagger をインストールできます:

composer require "darkaonline/swagger-lume:5.8.*"

Swagger を正常にインストールした後、config/app に以下を追加する必要があります.php ファイルの内容:

// Swagger プロバイダーの登録

$app->register(SwaggerLumeServiceProvider::class);

// Publish の登録

$app->gt; configure(' swagger-lume');
$app->register(SwaggerLumeServiceProvider::class);

// 構成、ビュー、アセットを公開する

$this->publishes([

__DIR__.'/../config/swagger-lume.php' => config_path('swagger-lume.php'),

], 'config');

Swagger ビューをアプリケーションの Routes/web.php ファイルに追加します:

$router->get('/' , function () use ($router) {

return view('swagger');

});

これにより、アプリケーションのルート パスの下に Swagger ドキュメントが表示されます。

API コントローラーの作成

API リクエストを処理するために、API マネージャー アプリケーションにコントローラーを作成する必要があります。次のコマンドを使用してコントローラーを作成できます:

php professional make:controller ApiController

これにより、app/Http/Controllers ディレクトリに ApiController.php という名前の新しいコントローラー ファイルが作成されます。

ApiController.php ファイルに、次のコードを追加します:

namespace AppHttpControllers;

use IlluminateHttpRequest;

class ApiController extends Controller

{

public function list()
{
    return response()->json(['status' => 'success', 'message' => 'API list']);
}

public function get($id)
{
    return response()->json(['status' => 'success', 'message' => 'API '.$id]);
}

public function create(Request $request)
{
    $name = $request->input('name');
    $url = $request->input('url');

    return response()->json(['status' => 'success', 'message' => 'API '.$name.' created']);
}

public function update(Request $request, $id)
{
    $name = $request->input('name');
    $url = $request->input('url');

    return response()->json(['status' => 'success', 'message' => 'API '.$id.' updated']);
}

public function delete($id)
{
    return response()->json(['status' => 'success', 'message' => 'API '.$id.' deleted']);
}

}

上記のコードは、API の一般的な操作メソッド (list、get、create、update、delete) を定義しています。

API ルーティング設定

次のコードを Routes/api.php ファイルに追加する必要があります:

$router->group(['prefix' => ; ' api'], function () use ($router) {

// List APIs
$router->get('list', 'ApiController@list');

// Get API
$router->get('get/{id}', 'ApiController@get');

// Create API
$router->post('create', 'ApiController@create');

// Update API
$router->put('update/{id}', 'ApiController@update');

// Delete API
$router->delete('delete/{id}', 'ApiController@delete');

});

これにより、各 API のリクエスト ルーティングが定義されます。

API のテスト

Postman などのツールを使用して API をテストできます。 Postman では、次のリクエスト URL を使用して API をテストできます:

GET http://localhost:8000/api/list

GET http://localhost:8000/api/get/1
POST http://localhost:8000/api/create
PUT http://localhost:8000/api/update/1
DELETE http://localhost:8000/api/delete/1

最後に、ローカル サーバーを起動し、次のコマンドを実行します。

php Artisanserve

これで、ブラウザで http://localhost:8000/ を開いて表示できるようになります。当社のオープンソース API 管理プラットフォーム システム。同時に、http://localhost:8000/api で API にアクセスすることもできます。 Swagger では、API のドキュメントを表示し、API のさまざまな機能をテストできます。

結論

PHP を使用してオープンソース API 管理プラットフォーム システムを実装することは難しくありません。 Laravel フレームワークと Swagger ツールを使用すると、完全な API 管理プラットフォーム システムを非常に簡単に構築できます。

オープンソース API 管理プラットフォーム システムをマスターすると、新しい道が開かれ、Web アプリケーションの世界がより面白く、刺激的なものになります。

以上がPHP はオープンソース API 管理プラットフォーム システムを実装しますの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。