APIコントラクト
Talend Cloud API DesignerまたはSwaggerからAPIコントラクトをインポートします。
Talend Cloud API Designerから
Talend Cloud API DesignerはTalendプラットフォームのモジュールで、チームが自分たちのAPIコントラクトをデザインし、ドキュメント化できるようにします。Talendでは、Talend Cloud API Designer からTalend Cloud API Testerへの組み込み統合が提供されており、ビルドするAPIとすばやくやり取りできます。インポートされたコントラクトは、既存のコントラクトからのブートストラップAPIテストにも非常に役立ちます。
Swagger 2.0
Swagger 2.0フォーマットの仕様は、GitHubのOpenAPI-Specificationリポジトリーで利用可能です。
現時点では、JSONのみがサポートされています。YAMLドキュメントがある場合は、Talend Cloud API Testerにインポートする前にJSONに簡単に変換できます。たとえばJSONからYAMLへのオンラインコンバーターを試すこともできます。
Swagger記述全体が新しいプロジェクトにインポートされます。以下の表に、インポート時に作成された項目を示します。
| Swagger項目 | 対応するTalend Cloud API Tester項目 | コメント |
|---|---|---|
| API | プロジェクト | 変換されたすべてのSwaggerを含むプロジェクト。名前と説明は、Swagger APIのタイトルと説明になります。 |
| パス | サービス | Swaggerの各パスは、サービスに変換されます。サービスはSwaggerパスの基本パスに基づいて名前が付けられます。 |
| 演算子 | リクエスト | Swaggerパスのすべての操作は、リクエストに変換され、上記のパスから抽出したサービスにあります。 |