機械翻訳について

RESTエンドポイント・メタデータとSwagger RESTメタデータ記述へのリンク

「RESTアダプタ」トリガー接続を使用して統合をアクティブ化すると、Integrationsページの上部にエンドポイントのメタデータURLリンクが提供されます。

たとえば:
integration Hello World (1.1.0) was activated successfully.
You can access it via http://host:port/ic/api/integration/v1/flows/rest/HELLO_WORLD/1.0/metadata.

このリンクを使用すると、APIのシェイプを検査できます。 メタデータには、エンドポイントの説明、エンドポイントURI、およびSwagger URIに関する追加情報が含まれています。

次の詳細に注意してください。

  • インバウンド(トリガー)方向で定義されたエンドポイント記述を使用してIARファイルをインポートし、接続を更新し、統合をアクティブにし、ブラウザのメタデータにアクセスする場合(たとえば、以下のような構造のURLを使用)着信方向に記述が定義されていても、エンドポイントの説明は表示されません。

    http://host:port/ic/api/integration/v1/flows/rest/OLD_INTG_DESC/1.0/metadata

    これは予期された動作です。 説明は、JCAファイルに格納され、そこから読み込まれ、表示されます。 既存の統合にはこのファイルはありません。 アップグレード後も、既存の統合ではエンドポイントの説明が表示されません。 正しい説明を取得するには、「RESTアダプタ」を再編集してアーティファクトを再度生成し、統合を再度アクティブにする必要があります。

  • /metadataまたは/metadata/swaggerというリソースURIを使用して、インポートされた統合または既存の統合をAdapter Endpoint Configuration Wizardで再編集しようとすると、ウィザードをナビゲートしてエラーを受け取ることができません。 これは、/metadataまたは/metadata/swaggerキーワードが予約されているためです。

  • 相対URIにテンプレート・パラメータがある場合、実行時に/metadataまたは/metadata/swaggerに解決された場合の相対URIの値は、統合メタデータを取得するための予約済みとして扱われます。 次の動作に注意してください。
    • /{param}: 許可 - この統合は、paramの値をメタデータとして起動することはできず、メタデータ・ページを戻します。

    • /{param}/swagger: 許可 - この統合は、paramの値をメタデータとして起動することはできず、Swaggerページを返します。

    • /metadata/{param}: 許可 - この統合は、paramの値をSwaggerとして起動することはできず、Swaggerページを返します。

  • メタデータとSwaggerは、統合用に事前定義済みの予約URIに応じてのみ提供されます。 metadataまたはswaggerで終わる任意のURIを持つリソースは、エンドポイントのドキュメント・アーティファクトと混同されません。