メイン コンテンツをスキップする 補完的コンテンツへスキップ

Talend Cloud API TesterでのAPIの試行

Talend Cloud API Testerを使用して、APIを操作します。

概要

APIプロジェクトの実装フェーズでは、定期的にAPIを操作して動作を検証する必要があります。また、API実装でインテグレーションテストを記述することで、そのコントラクトに準拠していることを確認する必要もあります。

APIが実装されると、コンシューマーは、クライアント実装で動作するAPIの機能を調べる必要もあります。

これらすべての目的のため、Talend Cloud API Designerにはエディタービューとライブドキュメンテーションの両方に、Talend Cloud API TesterでAPIを試すボタンが含まれています。

以下のいずれかをエクスポートできます:

  • API定義全体: プロジェクトはTalend Cloud API Testerで作成され、APIの各操作に対して事前に定義されたリクエストが存在します。これにより、APIの実際の使用法をエミュレートする複雑なシナリオを設定できます。
  • 単一オペレーション: Talend Cloud API Testerは、選択されたAPIオペレーションについてすぐに使用できるリクエストで開かれます。

Talend Cloud API Testerを使用するためには、Google ChromeとTalend Cloud API Tester拡張機能をインストールする必要があります。

詳細は、Talend Cloud API Testerの概要をご覧ください。

環境

初めて[Try in API Tester] (API Testerで試す)機能を使う時には、Talend Cloud API Testerに環境が自動で作成されます。以下のものが含まれます:
  • BaseUrlパブリック変数。API定義に公開済みエンドポイントが含まれると、デフォルト値として使用されます。公開済みエンドポイントが複数ある場合は、リストの一番目のエンドポイントが使用されます。公開済みエンドポイントがない場合は、値が空になります。
  • [SECURITY SCHEMES] (セキュリティスキーム)で定義された各認証方式のためのプライベート変数。

技術詳細:

Talend Cloud API Designerアイテム 対応するTalend Cloud API Testerのアイテム コメント
API ルートプロジェクト 単一プロジェクトで、名前はTalend Cloud API DesignerのAPIの名前に基づきます。
セクション サービス 整理の目的で使用します。
オペレーション リクエスト Talend Cloud API Designerセクションのすべてのオペレーションは、同じTalend Cloud API Testerサービスの下に収集されます。パス変数、クエリーパラメーター、ヘッダーもインポートされます。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。