Kong Gateway は、軽量、高速、かつ柔軟なクラウド ネイティブの API ゲートウェイです。サービス アプリケーションの前に位置し、リクエストとレスポンスを動的に制御、分析、ルーティングします。柔軟で、ローコード、プラグインベースのアプローチを使用して、API トラフィック ポリシーを実装します。
このチュートリアルでは、ローカル インストールのセットアップと、一般的な API 管理タスクの説明を通じて、Kong Gateway の使用を開始するのに役立つ情報を提供します。
このページでは、Kong Gateway を実行し、Admin API で検証する方法を説明します。このタスクが完了したら、チュートリアルの残りのタスクを実行してください。
curl
は、ほとんどのシステムにプレインストールされています。jq
なしで進める場合は、コマンドから jq
の処理を削除してください。Kong Gateway とサポートするデータベースをすばやく実行してチュートリアルを開始できるように、quickstart
スクリプトが提供されています。このスクリプトは、Docker で Kong Gateway を実行し、PostgreSQL データベースをバッキング データベースとして使用します。
quickstart
スクリプトを使用して、Kong Gateway を実行します。
curl -Ls https://get.konghq.com/quickstart | bash
注: quickstart スクリプトは、Kong Gateway を Free モードで実行します。Enterprise ライセンスで Kong を実行する場合は、環境変数を介してスクリプトにライセンスを渡します。この方法とその他の高度な使用方法については、コード リポジトリのドキュメントを参照してください。
このスクリプトは、Kong Gateway とサポートする PostgreSQL データベースの Docker コンテナーを実行します。また、これらのコンテナーが通信するための Docker ネットワークも作成します。データベースは適切な移行手順で初期化され、Kong Gateway の準備が整うと、次のメッセージが表示されます。
✔ Kong is ready!
Kong Gateway が起動していることを確認します。
Kong Gateway は、デフォルトのポート 8001
で Admin API を提供しています。Admin API を使用して、Kong Gateway の状態を照会したり、制御することができます。次のコマンドは、Admin API に照会して、ヘッダーのみをフェッチします。
curl --head localhost:8001
Kong Gateway が正常に動作している場合、次のような 200
HTTPコードが返されます。
HTTP/1.1 200 OK
Date: Mon, 22 Aug 2022 19:25:49 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
Content-Length: 11063
X-Kong-Admin-Latency: 6
Server: kong/3.2.1
Kong Gateway の設定を評価します。
Admin API の root ルートは、ネットワーク、セキュリティ、プラグイン情報など、稼働中の Kong Gateway に関する重要な情報を提供します。完全な設定は、JSON ドキュメントの .configuration
キーで提供されます。
curl -s localhost:8001 | jq '.configuration'
Kong Gateway の設定情報を含む大きな JSON レスポンスが返されるはずです。
このチュートリアルの各ステップでは、Kong Gateway が動作している必要があります。そのため、すべてを実行したまま、チュートリアルの次のステップに進みます。