download top

ドキュメント (0.10.ｘ)

Kong がどのようにして API を加速していくのか学びましょう。
注意！ 現在閲覧中のドキュメントは、Kong の旧バージョンです。最新のドキュメントは、こちらからご覧ください。

プラグインの有効化


始める前に:
  1. 必ず Kong をインストールしてください - インストールは数分で完了します！
  2. 次に、Kong が起動していることを確認してください。
  3. そして、Kong に API が追加されたことを確認してください。

このセクションでは、Kong プラグインの設定方法を学ぶことができます。Kong の真髄でもある原則の 1 つは、プラグインを介した拡張性です。プラグインによって、新しい機能を簡単に API へ追加したり、API を管理しやすくすることができます。

以下の手順では、鍵認証プラグインを設定して、API に認証機能を追加します。このプラグインを追加する以前に、API に対する すべてのリクエストは、アップストリームにプロキシされます。このプラグインを追加および設定すると、適切な API キーを持ったリクエストのみがプロキシされ、その他のリクエストは Kong によって拒否されます。そのため、不正な使用からアップストリーム サービスを保護することができます。


  1. API のための鍵認証プラグインの設定

    先程「API の追加」ページで作成した example-api 上で、以下の cURL を実行します:

    $ curl -i -X POST \
  --url http://localhost:8001/apis/example-api/plugins/ \
  --data 'name=key-auth'

    注意:このプラグインでは、初期値が [apikey] である config.key_names パラメーターも使用可能です。これは、リクエストの最中に API キーを含有するヘッダーおよびパラメーターの名前のリスト (両方サポートされています) になります。

  2. プラグインが適切に設定されたことを確認

    以下の cURL を実行して、API 上で鍵認証が適切に設定されたことを確認します:

    $ curl -i -X GET \
  --url http://localhost:8000/ \
  --header 'Host: example.com'

    認証に必須の apikey ヘッダーまたはパラメーターを指定していなかったため、レスポンスには 403 Forbidden が表示されます。

    HTTP/1.1 403 Forbidden
...

{
  "message": "Your authentication credentials are invalid"
}

  3. 次のステップ

    ここまでで、鍵認証プラグインの設定が完了したので、次に API へコンシューマーを追加し、Kong を介してリクエストのプロキシを続ける方法を学びましょう。

    「コンシューマーの追加」を参照する。

価格/お問い合わせ

製品の詳細、価格、ライセンス体系、デモの依頼など、お気軽にお問い合わせください。