API の設計

Red Hat Fuse 7.7

OpenShift での Fuse アプリケーション用の REST API の設計

Red Hat Fuse Documentation Team

概要

Web ベース REST API Designer の使用ガイド

第1章 API Designer の概要

Red Hat Fuse on OpenShift は、Web ベースの API エディターである API Designer を提供します。API Designer を使用して API サービスの特定ベンダーに依存しない移植可能なオープン記述形式である OpenAPI 仕様 (バージョン 3 または 2) に準拠する REST API を設計することができます。API Designer は、「軽量」バージョンの Apicurio Studio オープンソースプロジェクト (https://www.apicur.io/) です。これは、API Designer セッションはステートレスであり、各セッションの終わりに API 定義を JSON ファイルとして保存する必要があることを意味しています。

また、API Designer を使用して REST API 定義に基づいて事前の Fuse プロジェクトを生成することができます。その後、Fuse 開発環境でプロジェクトの Camel ルートを完了し、プロジェクトをビルドすることができます。最後に、生成される REST サービスを Fuse on OpenShift にデプロイすることができます。

以下は、API Designer を使用して REST API を Fuse on OpenShift のアプリケーションソリューションに組み込む方法についての概要です。

  1. API Designer を OpenShift プロジェクトにサービスとして追加します。
  2. API Designer で、以下を実行します。

    • API Designer で API 定義を作成します。REST API 定義を JSON ファイルとしてローカルファイルシステムに保存します。API 定義が完了していなくても、編集セッション中にいつでも API 定義を保存することができます。
    • API 定義を API Designer にアップロードします。
    • 現在の REST API 定義に基づいて Fuse Camel プロジェクトを生成します。API Designer は、完全な Maven プロジェクトが含まれるダウンロード可能な zip ファイルを提供します。
  3. Fuse 開発環境で、生成される Fuse プロジェクトによって提供されるスケルトン実装を完了します。
  4. Fuse アプリケーションをビルドし、OpenShift にデプロイします。
  5. (任意の手順) Fuse アプリケーションを見つけ、これを設定するために 3scale サービス検出機能を使用して Fuse アプリケーションを Red Hat 3scale API Management に統合します。

第2章 API Designer の OpenShift クラスターへのサービスとしての追加

2.1. API Designer をサービスとして OpenShift 4 プロジェクトに追加

OpenShift 4.x では、『Fuse on OpenShift ガイド』の説明どおりに、OpenShift 管理者が API Designer Operator をインストールし、サブスクライブしたことを確認する必要があります。

OpenShift 管理者が任意で API Designer をサービスとしてプロジェクトに追加した可能性もあります。そうでない場合は、それを行う必要があります。

注記

API Designer の旧名である Apicurito は今でも API Designer Operator のインターフェースに表示されます。

前提条件

OpenShift 管理者が API Designer Operator をインストールし、OpenShift プロジェクトにサブスクライブしている必要があります。

手順

  1. Web ブラウザーで OpenShift コンソールを開き、認証情報 (例: ユーザー名 developer およびパスワード developer) を使用してログインします。
  2. Topology を選択します。
  3. API Designer Operator が含まれるプロジェクトを選択します。
  4. apicurito-operator というラベルが付けられたアイコンが表示されることを確認します。

    API Designer operator

    apicurito-service の別のアイコンがある場合、API Designer はすでにサービスとしてプロジェクトに追加されています。

    apicurito-service のアイコンがない場合は、ステップ 5 に進みます。

  5. 左側のナビゲーションペインで Add+ をクリックします。
  6. From Catalog オプションを追加します。
  7. 検索フィールドに API と入力してカタログ項目をフィルターします。
  8. Apicurito CRD カードをクリックします。
  9. Create をクリックします。

    API Designer インスタンスの最小限の開始テンプレートがあるデフォルトのフォームが開かれます。Size オプションは API Designer の Pod の数を示します。デフォルトは、API Designer の管理に特化したロジックが含まれる新規リソースタイプの 3 つの Pod になります。

  10. デフォルト値を使用するか、任意で値を編集します。
  11. Create をクリックし、新しい API Designer インスタンスの Pod、サービス、およびその他のコンポーネントの起動をトリガーします。
  12. API Designer サービスがプロジェクトに追加されたことを確認するには、Topology を選択し、apicurito-service のアイコンが表示されることを確認します。

2.2. API Designer をサービスとして OpenShift 3 プロジェクトに追加

OpenShift サービスカタログから、API Designer をサービスとして OpenShift 3 プロジェクトに追加できます。このインスタンスは、OpenShift 環境外の URL からアクセスできます。

前提条件

  • OpenShift システム管理者が推奨するガイドラインに従って、API Designer へのアクセスが可能なホスト名を取得します。
  • コマンドウィンドウで以下のコマンドを実行して、Fuse on OpenShift イメージとテンプレート (apidesigner-ui および fuse-apidesigner-generator を含む)が OpenShift クラスターにインストールされていることを確認します。

    oc get is -n openshift

    イメージおよびテンプレートが事前にインストールされていない場合や、提供されたバージョンが古い場合は、『Fuse on OpenShift ガイド』に説明されているように Fuse on OpenShift イメージおよびテンプレートをインストール (または更新) します。

手順

API Designer を OpenShift プロジェクトにサービスとして追加するには、以下を実行します。

  1. コマンドウィンドウで、OpenShift サーバーにログインします。

    oc login -u developer -p developer
  2. 新規プロジェクト namespace を作成します。たとえば、以下のコマンドは test という名前の新規プロジェクトを作成します。

    oc new-project test
  3. Web ブラウザーで OpenShift コンソールを開き、クレデンシャル (例: ユーザー名 developer およびパスワード developer) を使用してログインします。
  4. Catalog をクリックします。カタログ検索フィールドに API Designer を入力してから Red Hat Fuse API Designer を選択します。

    Red Hat Fuse API Designer ウィザードの Information ステップが開きます。

  5. Next をクリックします。

    Red Hat Fuse API Designer ウィザードの Configuration ステップが開きます。

  6. Image Stream Namespace フィールドに、openshift を入力します。
  7. ROUTE_HOSTNAME フィールドに、API Designer インスタンスへのアクセスを可能にする外部ホスト名を入力します (例: apidesigner-myproject.192.168.64.43.nip.io)。
  8. Configuration ステップの残りの設定についてデフォルトの値を受け入れ、 Create をクリックします。

    テンプレートウィザードの Results ステップが開きます。

  9. Close をクリックします。
  10. OpenShift Web コンソールの My Projects ペインで、プロジェクト (例: test)を選択します。

    プロジェクトの Overview タブが開き、apidesigner-ui アプリケーションが表示されます。

  11. apidesigner-ui デプロイメントの左側にある矢印をクリックして、デプロイメントの詳細情報を展開し、表示します。
  12. API Designer インスタンスのリンクをクリックします (例: https://apidesigner-myproject.192.168.64.43.nip.io)。

    API Designer が新規の Web ブラウザーウィンドウまたはタブで開きます。

注記

API Designer インスタンスを開くことができない場合は、以下の構文を使用して、コンピューターの /etc/hosts ファイルを編集して ROUTE_HOSTNAME を追加する必要がある場合があります。ここで、$OPENSHIFT_IP_ADDR は OpenShift サーバーの IP アドレスであり、apidesigner.my-minishift.apicurio.io はステップ 7 で指定した ROUTE_HOSTNAME です。

$OPENSHIFT_IP_ADDR apidesigner.my-minishift.apicurio.io

第3章 API Designer を使用した API 定義の設計および開発

API Designer を使用して、OpenAPI 3 (または 2) 仕様に準拠する REST API 定義を設計し、開発できます。

前提条件

  • OpenShift プロジェクトが作成済みである必要があります。
  • API Designer サービスが OpenShift プロジェクトに追加済みである必要があります。

3.1. API Designer での REST API 定義の作成

以下の手順では、REST API 定義を作成する方法を説明します。

注記
  • Fuse Online または Fuse on OpenShift から API Designer ユーザーインターフェースにアクセスできます。
  • Fuse on OpenShift のみの場合、API Designer はステートレスです。つまり、作業が OpenShift セッション間で保存されません。セッションごとに API をローカルファイルシステムに保存する必要があります。

サンプルについて

Task Management API のサンプルは、営業コンサルタントがお客様側の担当者と対話する際に必要なタスクを追跡するために使用する可能性のある単純な API をシミュレートします。「to-do」タスクの例には「create an account for a new contact (新規の担当者のアカウントの作成)」や「place an order for an existing contact (既存の担当者の注文処理)」が含まれる可能性があります。Task Management API のサンプルを実装するには、複数のタスク用のパスと、特定のタスク用のパスの 2 つのパスを作成します。その後、タスクを作成し、すべてのタスクまたは特定のタスクを取得し、タスクを更新してタスクを削除する操作を定義します。

前提条件

  • 作成する必要のある API のエンドポイントを把握している。Task Management API のサンプルの場合、/todo および /todo/{id} の 2 つのエンドポイントがあります。
  • Fuse on OpenShift のみの場合、OpenShift プロジェクトを作成しており、API Designer サービスを OpenShift プロジェクトに追加している。

手順

  1. Fuse Online を使用している場合は、ステップ 2 に進みます。

    Fuse on OpenShift を使用している場合:

    1. OpenShift Web コンソールにログインし、API Designer が含まれるプロジェクトを開きます。
    2. OpenShift 4.x の場合は、Topology を選択し、apicurito-service アイコンの URL リンクをクリックします。

      OpenShift 3.11 の場合は、アプリケーションの一覧で API Designer の URL をクリックします (例: https://apidesigner-myproject.192.168.64.43.nip.io)。

      API Designer 用の新規ブラウザーウィンドウまたはタブが開きます。

      注記

      API Designer は軽量バージョンの Apicurio Studio オープンソースプロジェクトであるため、「Apicurio」が API Designer インターフェースに表示されます。

  2. New API をクリックします。新規の API ページが開きます。

    デフォルトでは、API Designer は OpenAPI 3 仕様を使用します。OpenAPI 2 仕様を使用する場合は、New API ボタンの横にある矢印をクリックし、OpenAPI 2 を選択します。

    注記

    OpenAPI 2 仕様に基づいて API を開く場合、API Designer の Convert to OpenAPI 3 オプションを使用して、API が OpenAPI 3 仕様に準拠するよう変換することができます。

  3. API 名を変更するには、以下を実行します。

    1. 名前にカーソルを合わせ、表示される編集アイコン ( 28 ) をクリックします。
    2. 名前を編集します。たとえば、Task API を入力します。
    3. チェックマークアイコンをクリックして、名前変更を確認します。
  4. 任意で以下を行います。

    • バージョン番号と説明を提供します。
    • 連絡先情報 (名前、メールアドレス、および URL) を追加します。
    • ライセンスを選択します。
    • タグを定義します。
    • サーバーを 1 つ以上定義します。
    • セキュリティースキームを設定します。
    • セキュリティー要件を指定します。
  5. API のそれぞれのエンドポイントへの相対パスを定義します。フィールド名はスラッシュ (/) で開始する必要があります。

    Task Management API のサンプルでは、2 つのパスを作成します。

    • 複数のタスクのパス: /todo
    • ID 別の特定タスクのパス: /todo/{id}

      apidesigner paths
  6. 任意のパスパラメーターのタイプを指定します。

    id パラメーターのサンプルは、以下のようになります。

    1. Paths リストで、/todo/{id} をクリックします。

      id パラメーターが PATH PARAMETERS セクションに表示されます。

    2. Create をクリックします。
    3. description (説明) には、The ID of the task to find. と入力します。
    4. type (タイプ) には、integer32-Bit integer として選択します。

      apidesigner parameter
  7. Data Types セクションで、API の再利用可能なタイプを定義します。

    1. Add a data type をクリックします。
    2. Add Data Type ダイアログで名前を入力します。Task Management API のサンプルでは、Todo と入力します。
    3. オプションで、API Designer がデータタイプのスキーマの作成に使用するサンプルを指定できます。生成されるスキーマを編集できます。

      Task Management API のサンプルでは、以下の JSON 例で開始します。

      {
          "id": 1,
          "task": "my task",
          "completed": false
      }
    4. オプションで、該当するデータタイプを指定して REST リソースの作成を選択できます。
    5. Save をクリックします。サンプルを指定している場合、API Designer はそのサンプルからスキーマを生成します。

      apidesigner datatype schema
  8. オプションで、スキーマのプロパティーを編集し、新しいプロパティーを追加できます。
  9. Task Management API のサンプルの場合、タイプ stringtask という名前の 1 つのプロパティーを使用して、 Task という名前の別のデータタイプを作成します。

    apidesigner another type
  10. それぞれのパスについて、操作 (GET、PUT、POST、DELETE、 OPTIONS、HEAD、または PATCH) を定義します。

    Task Management API のサンプルの場合、以下の表で説明されているように操作を定義します。

    表3.1 Task Management API 操作

    パス操作説明リクエストボディー応答

    /todo

    POST

    新しいタスクを作成します。

    メディアタイプ: application/json データタイプ: Task

    • ステータスコード: 201 説明: Task created

      応答ボディー: メディアタイプ: application/json データタイプ: Todo

    /todo

    GET

    すべてのタスクを取得します。

    該当なし

    • ステータスコード: 200 説明: Task deleted
    • ステータスコード: 400 説明: Task not deleted

    /todo/{id}

    GET

    ID 別にタスクを取得します。

    該当なし

    • ステータスコード: 200 説明: Task found for ID 応答ボディー: メディアタイプ: application/json データタイプ: Task
    • ステータスコード: 404 説明: No task with provided identifier found.

    /todo/{id}

    UPDATE

    ID 別にタスクを更新します。

    リクエストボディーのタイプ: Task

    • ステータスコード: 200 説明: Completed
    • ステータスコード: 400 説明: Task not updated

    /todo/{id}

    DELETE

    ID 別にタスクを削除します。

    該当なし

    • ステータスコード: 200 説明: Task deleted
    • ステータスコード: 400 説明: Task not deleted
  11. API Designer での検証問題の解決」の説明どおりに問題を解決します。
  12. Fuse on OpenShift のみの場合には、Save As をクリックして API 仕様を保存し、JSON または YAML 形式を選択します。

    JSON または YAML ファイルがローカルダウンロードフォルダーにダウンロードされます。デフォルトのファイル名は、適切なファイル拡張子を含む openapi-spec です。

その他のリソース

3.2. API Designer での検証問題の解決

API の作成および編集時に、API Designer は感嘆符 (!) アイコンと、API Designer タイトルバーの問題のリストを使って解決する必要のある問題を特定します。

前提条件

  • API Designer で API を開いている。

手順

  1. 感嘆符 (!) アイコンで示唆される問題を検索します。以下に例を示します。

    API Designer issue
  2. 感嘆符アイコンをクリックして、問題の説明を表示します。以下に例を示します。

    API Designer issue
  3. 問題の説明で提供される情報を基に、問題のある場所に移動して、修正します。

    たとえば、「Operation must have at least one response」(オペレーションには 1 つ以上の応答が必要) の問題を修正するには、GET オペレーションをクリックして開き、Add a response をクリックします。

    apidesigner issuelocate

    応答の説明の入力後、問題は解決され、感嘆符アイコンは表示されなくなります。

    apidesigner issuefix
  4. すべての問題の概要については、以下のようになります。

    1. 右上にある Issues リンクをクリックします。

      All issues
    2. 特定の問題の Go to a problem をクリックし、その問題を解決するために問題のある場所に移動します。

      List of issues

第4章 REST API をベースとした Fuse アプリケーションの実装、ビルドおよびデプロイ

Red Hat Fuse API Designer を使用して、REST API 定義に基づいて Camel Fuse プロジェクトを生成できます。Fuse 開発環境では、Camel ルートおよび Rest DSL API を完了できます。最後に、プロジェクトをビルドし、作成されたアプリケーションを Fuse on OpenShift にデプロイすることができます。

前提条件

  • OpenAPI 3 (または 2) 仕様に準拠する既存の API 定義が必要です。例: API Designer で作成した openapi-spec.json ファイル。
  • API Designer がローカル OpenShift クラスターにインストールされ、実行されている。
  • API Designer がサービスとして追加された既存の OpenShift プロジェクトがある。
  • Maven と Red Hat Fuse がインストールされている。

以下のトピックでは、REST API をベースとして Fuse アプリケーションの実装、ビルドおよびデプロイを実行する方法について説明します。

4.1. API 定義の API Designer へのアップロード

既存の API 定義を API Designer にアップロードできます。

前提条件

  • OpenAPI 3 (または 2) 仕様に準拠する既存の API 定義が必要です。例: API Designer で作成した openapi.json ファイル。
  • API Designer がローカル OpenShift クラスターにインストールされ、実行されている。
  • API Designer がアプリケーションとして追加された既存の OpenShift プロジェクトがある。

手順

  1. OpenShift Web コンソールで、API Designer を含むプロジェクトを開きます。
  2. API Designer コンソールを開きます。プロジェクトのアプリケーション一覧で、apidesigner の下にある URL をクリックします。例: https://apidesigner-myproject.192.168.64.38.nip.io

    API Designer コンソールは、別の Web ブラウザータブまたはウインドウで開きます。

  3. Open API をクリックします。

    ファイルマネージャーウィンドウが開きます。

  4. ファイルマネージャーウィンドウで、以下を実行します。

    1. 既存の OpenAPI 定義ファイル (例: openapi.json) が含まれるフォルダーに移動します。
    2. OpenAPI 定義ファイルを選択し、Open をクリックします。

      OpenAPI 定義が API Designer コンソールで開きます。

4.2. API Designer からの Fuse Camel プロジェクトの生成

API Designer を使用し、API 定義に基づいて Fuse Camel プロジェクトを生成できます。

前提条件

  • API Designer がローカル OpenShift クラスターにインストールされ、実行されている。
  • API Designer がアプリケーションとして追加された既存の OpenShift プロジェクトがある。
  • API Designer コンソールで API 定義ファイルを作成し、開いている。

手順

API Designer コンソールで、以下を実行します。

  1. Generate をクリックします。
  2. ドロップダウンリストから Fuse Camel Project を選択します。

API Designer は camel-project.zip ファイルを生成し、ローカルのデフォルトダウンロードフォルダーにダウンロードします。

zip ファイルには、Camel の Rest DSL を使用して API 定義のデフォルトのスケルトン実装を提供し、すべてのリソース操作に対応する Fuse Camel プロジェクトが含まれます。またプロジェクトには、プロジェクトの生成に使用した元の OpenAPI 定義ファイルも含まれます。

4.3. API Designer で生成される Camel プロジェクトの完了

API Designer は、Camel の Rest DSL を使用して API 定義のデフォルトのスケルトン実装を提供し、すべてのリソース操作に対応する Fuse プロジェクトを生成します。Fuse 開発環境で、プロジェクトを完了します。

前提条件

  • API Designer によって生成された camel-project.zip ファイルがある。
  • (オプション) Fuse Tooling を使用して Red Hat Developer Studio をインストールしている。

手順

  1. API Designer によって生成された camel-project.zip ファイルを一時フォルダーに解凍します。
  2. Red Hat Developer Studio を開きます。
  3. Developer Studio で FileImport を選択します。
  4. Import ダイアログで、MavenExisting Maven Projects を選択します。
  5. エディタービューでプロジェクトの camel-context.xml ファイルを開きます。
  6. REST タブをクリックして Rest DSL コンポーネントを編集します。

    REST サービスの定義についての詳細は、『Apache Camel Development Guide』の「Defining REST services」セクションを参照してください。

    Swagger サポートで JAX-RS エンドポイントを拡張する方法については、『Apache CXF Development Guide』を参照してください。

    Fuse Tooling REST エディターの使用方法は、『Tooling User Guide』の「Viewing and editing Rest DSL components」セクションを参照してください。

  7. Design タブで Camel ルートを編集します。

    Camel ルートの編集に関する詳細は、『Tooling User Guide』の「Editing a routing context in the route editor」セクションを参照してください。

4.4. REST サービスのビルドとデプロイ

Fuse プロジェクトの完了後に、プロジェクトを OpenShift でビルドし、デプロイすることができます。

前提条件

  • REST サービスを定義する完全なエラーのない Fuse プロジェクトがある。
  • Java 8 JDK (以降) および Maven 3.3.x(以降)をインストールしている。

手順

Minishift または Red Hat Container Development Kit などの単一ノードの OpenShift クラスターがインストールされ、実行中である場合、プロジェクトをそこにデプロイできます。

このプロジェクトを実行中の単一ノードの OpenShift クラスターにデプロイするには、以下を実行します。

  1. OpenShift クラスターにログインします。

    $ oc login -u developer -p developer
  2. プロジェクトの新規 OpenShift プロジェクトを作成します。たとえば、以下のコマンドは test-deploy という名前の新規プロジェクトを作成します。

    $ oc new-project test-deploy
  3. ディレクトリーを Fuse Camel プロジェクトが含まれるフォルダーに変更します (例: myworkspace/camel-project)。

    $ cd myworkspace/camel-project
  4. プロジェクトを OpenShift クラスターにビルドし、デプロイします。

    $ mvn clean fabric8:deploy -Popenshift
  5. ブラウザーで OpenShift コンソールを開き、プロジェクト (例: test-deploy)に移動します。camel-project アプリケーションの Pod が起動していることを確認できるまで待機します。
  6. プロジェクトの Overview ページで、camel-project アプリケーションの URL を特定します。URL で使用される形式は次のとおりです: http://camel-project-MY_PROJECT_NAME.OPENSHIFT_IP_ADDR.nip.io
  7. URL をクリックしてサービスにアクセスします。

第5章 3scale の検出についての API サービスの準備

Red Hat 3scale API Management を使用すると、パブリックインターネット上の API サービスへのアクセスを制御できます。3scale の機能には、サービスレベルアグリーメント (SLA) の実施、API バージョンの管理、セキュリティーおよび認証サービスの提供などが含まれます。Fuse は 3scale の サービス検出機能をサポートします。 これにより、3scale 管理ポータル UI から Fuse サービスを簡単に検出できます。サービス検出を使用して、同じ OpenShift クラスターで実行されている Fuse アプリケーションをスキャンし、関連付けられた API 定義を 3scale に自動的にインポートできます。

前提条件

  • API サービスを提供する Fuse アプリケーションが OpenShift でデプロイされ、実行されていること。
  • Fuse アプリケーションには、3scale によって検出されるように必須のアノテーションが付けられていること。

    注記

    API Designer によって生成される Fuse プロジェクトは、必要なアノテーションを自動的に提供するように事前に設定されています。

    API Designer によって生成されない Fuse プロジェクトの場合、「API Designer によって生成されない Fuse プロジェクトのアノテーションの追加」の説明どおりに、プロジェクトを設定する必要があります。

  • 3scale API Management システムは、検出される API サービスと 同じ OpenShift クラスターにデプロイされます。

3scale で API サービスを検出する手順についての詳細は、Red Hat 3scale API Management『管理ポータルガイド』の「サービスディスカバリー」を参照してください。

5.1. API Designer によって生成されない Fuse プロジェクトのアノテーションの追加

3scale が API サービスを検出できるようにするには、API サービスを提供する Fuse アプリケーションに、検出を可能にする Kubernetes サービスアノテーションが含まれている必要があります。これらのアノテーションは、Fabric8 Maven Plugin の一部である Fabric8 Service Discovery Enricher によって提供されます。

Apache Camel Rest DSL プロジェクトの場合、Fabric8 Maven Plugin はデフォルトで Fabric8 Service Discovery Enricher を実行します。

API Designer によって生成される Fuse プロジェクトは、必要なアノテーションを自動的に提供するよう事前に設定されます。

手順

API Designer によって生成されていない Fuse Rest DSL プロジェクトの場合、プロジェクトを以下のように設定します。

  1. 以下の例のように、Fuse プロジェクトの pom.xml ファイルを編集し、fabric8-maven-plugin 依存関係を組み込みます。

    <plugin>
            <groupId>org.jboss.redhat-fuse</groupId>
            <artifactId>fabric8-maven-plugin</artifactId>
            <version>${fuse.version}</version>
            <executions>
              <execution>
                <goals>
                  <goal>resource</goal>
                  <goal>build</goal>
                </goals>
              </execution>
            </executions>
      </plugin>

    Fabric8 Maven Plugin は、特定のプロジェクトレベルの条件が満たされる場合は Fabric8 Service Discovery Enricher を実行します(例: プロジェクトは Camel Rest DSL プロジェクトである必要があります)。「API サービスアノテーション値のカスタマイズ」の説明にあるように、 Enricher の動作をカスタマイズする必要がない場合は、Fabric8 Service Discovery Enricher を pom.xml ファイルで依存関係として指定する必要はありません。

  2. Fuse Rest DSL プロジェクトの camel-context.xml ファイルで、以下の属性を restConfiguration 要素に指定します。

    • scheme: サービスがホストされる URL のスキーム部分です。「http」または「https」を指定できます。
    • contextPath: API サービスがホストされる URL のパスの部分です。
    • apiContextPath: API サービス記述ドキュメントがホストされる場所へのパスです。ドキュメントがセルフホストされている場合は相対パスを指定でき、ドキュメントが外部でホストされる場合は完全な URL を指定できます。

      サンプル camel-context.xml ファイルからの以下の抜粋には、アノテーションの属性値が restConfiguration 要素に表示されています。

      <?xml version="1.0" encoding="UTF-8"?>
      <beans xmlns="http://www.springframework.org/schema/beans"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="
             http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
             http://camel.apache.org/schema/spring       http://camel.apache.org/schema/spring/camel-spring.xsd">
      
          <camelContext xmlns="http://camel.apache.org/schema/spring">
              <restConfiguration component="servlet" scheme="https"
                    contextPath="myapi" apiContextPath="myapi/openapi.json"/>
      ...

Enricher は、これらの restConfiguration 要素の属性値で指定される情報を使用し、discovery.3scale.net/schemediscovery.3scale.net/path、および discovery.3scale.net/description-path アノテーションの値を作成します。これにより、Red Hat 3scale API Management『管理ポータルガイド』の「サービスディスカバリー」の説明にあるように、プロジェクトのデプロイされた OpenShift サービスを 3scale で検出可能にすることができます。

Enricher は以下のラベルとアノテーションを追加して、サービスが 3scale で検出できるようにします。

  • discovery.3scale.net ラベル: デフォルトで、Enricher はこの値を「true」に設定します。3scale はセレクター定義を実行して検出を必要とするすべてのサービスを検索する際にこのラベルを使用します。
  • 以下のアノテーションを使用できます。

    • discovery.3scale.net/discovery-version: (任意) 3scale 検出プロセスのバージョンです。Enricher はデフォルトでこの値を「v1」に設定します。
    • discovery.3scale.net/scheme: サービスがホストされる URL のスキーム部分です。Enricher は、restConfiguration 要素の scheme 属性で上書きしない限り、デフォルトの「http」を使用します。他の使用できる値は「https」です。
    • discovery.3scale.net/path: サービスがホストされる URL のパスの部分です。このアノテーションは、パスがルート「/」にある場合に省略されます。Enricher は、この値を restConfiguration 要素の path 属性から取得します。
    • discovery.3scale.net/port: サービスのポート。Enricher はこの値を Kubernetes サービス定義から取得します。これには、公開するサービスのポート番号が含まれます。Kubernetes サービス定義が複数のサービスを公開する場合、Enricher は一覧表示される最初のポートを使用します。
    • discovery.3scale.net/description-path: (任意) OpenAPI サービス記述ドキュメントへのパスです。Enricher は、この値を restConfiguration 要素の contextPath 属性から取得します。

API サービスアノテーション値のカスタマイズ」の説明どおりに、Fabric8 Service Discovery Enricher の動作をカスタマイズできます。

5.2. API サービスアノテーション値のカスタマイズ

Maven Fabric8 プラグインは、デフォルトで Fabric8 Service Discovery Enricher を実行します。Enricher は、Red Hat 3scale API Management『管理ポータルガイド』ガイドの「検出されたサービスのインポート」で説明されているように、アノテーションを Fuse Rest DSL プロジェクトの API サービスに追加して API サービスを 3scale で検出できるようにします。

Enricher は一部のアノテーションのデフォルト値を使用し、プロジェクトの camel-context.xml ファイルから他のアノテーションの値を取得します。

デフォルト値や camel-context.xml ファイルで定義される値は、Fuse プロジェクトの pom.xml ファイルや service.yml ファイルに値を定義して上書きできます。(両方のファイルで値を定義する場合、Enricher は service.yml ファイルから値を使用します。) Fabric8 Service Discovery Enricher に指定できる要素の説明については、「Fabric8 Service Discovery Enricher 要素」を参照してください。

手順

Fuse プロジェクトの pom.xml ファイルにアノテーションの値を指定するには、以下を実行します。

  1. 任意のエディターで Fuse プロジェクトの pom.xml ファイルを開きます。
  2. 以下の例のように、fabric8-maven-plugin の依存関係を見つけます。

    <plugin>
            <groupId>org.jboss.redhat-fuse</groupId>
            <artifactId>fabric8-maven-plugin</artifactId>
            <version>${fuse.version}</version>
            <executions>
              <execution>
                <goals>
                  <goal>resource</goal>
                  <goal>build</goal>
                </goals>
              </execution>
            </executions>
      </plugin>
  3. 以下の例のように、Fabric8 Service Discovery Enricher を Fabric8-Maven プラグインに依存関係として追加します。

    <plugin>
      <groupId>org.jboss.redhat-fuse</groupId>
      <artifactId>fabric8-maven-plugin</artifactId>
      <version>${fuse.version}</version>
      <executions>
        <execution>
          <goals>
            <goal>resource</goal>
            <goal>build</goal>
          </goals>
        </execution>
      </executions>
      <dependencies>
        <dependency>
          <groupId>io.acme</groupId>
          <artifactId>myenricher</artifactId>
          <version>1.0</version>
          <configuration>
            <enricher>
              <config>
                <f8-service-discovery>
                  <scheme>https</scheme>
                  <path>/api</path>
                  <descriptionPath>/api/openapi.json</descriptionPath>
                </f8-service-discovery>
              </config>
            </enricher>
          </configuration>
          </dependency>
      </dependencies>
    </plugin>
  4. 変更を保存します。

または、src/main/fabric8/service.yml フラグメントを使用して、以下の例のようにアノテーション値を上書きできます。

kind: Service
name:
metadata:
  labels:
    discovery.3scale.net/discoverable : "true"
  annotations:
    discovery.3scale.net/discovery-version : "v1"
    discovery.3scale.net/scheme : "https"
    discovery.3scale.net/path : "/api"
    discovery.3scale.net/port : "443"
    discovery.3scale.net/description-path : "/api/openapi.json"
spec:
  type: LoadBalancer

5.3. Fabric8 Service Discovery Enricher 要素

以下の表は、デフォルト値や camel-context.xml ファイルで定義された値を上書きする必要がある場合に Fabric8 Service Discovery Enricher に指定できる要素について説明しています。

これらの値は Fuse Rest DSL プロジェクトの pom.xml ファイルや src/main/fabric8/service.yml ファイルで定義できます。(両方のファイルで値を定義する場合、Enricher は service.yml ファイルから値を使用します。) 例は「API サービスアノテーション値のカスタマイズ」を参照してください。

表5.1 Fabric8 Service Discovery Enricher 要素

要素説明デフォルト

springDir

camel-context.xml ファイルが含まれる spring 設定ディレクトリーへのパスです。

Camel Rest DSL プロジェクトを認識するために使用される /src/main/resources/spring パスです。

scheme

サービスがホストされる URL のスキーム部分です。「http」または「https」を指定できます。

http

path

API サービスがホストされる URL のパスの部分です。

 

port

API サービスがホストされる URL のポートの部分です。

80

descriptionPath

API サービス記述ドキュメントがホストされる場所へのパスです。ドキュメントがセルフホストされている場合は相対パスを指定でき、ドキュメントが外部でホストされる場合は完全な URL を指定できます。

 

discoveryVersion

3scale 検出の実装のバージョンです。

v1

discoverable

discovery.3scale.net ラベルを true または false のいずれかに設定する要素です。

true に設定すると、3scale はこのサービスの検出を試行します。

false に設定すると、3scale はこのサービスの検出を試行しません。

この要素をスイッチとして使用し、「false」に設定することで 3scale 検出の統合を一時的にオフにできます。

値を指定しない場合、Enricher はサービスを検出可能にできるかどうかについて自動検出を試行します。Enricher がサービスが検出不可能であると判別すると、3scale はこのサービスの検出を試行しません。

法律上の通知

Copyright © 2020 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.