OpenAPI仕様とRAML定義を使って作業 - Cloud

Talend Cloud API Designerユーザーガイド

Version
Cloud
Language
日本語
Product
Talend Cloud
Module
Talend API Designer
Content
ジョブデザインと開発 > Designing APIs
Last publication date
2024-03-13
OAS(旧称Swagger)およびRAML仕様に従ってAPI定義を作成します。 Talend Cloud API Designerエディターでは、複雑な構文を知らなくても、これらの仕様を使用できます。Talend Cloud API Designerの単一APIデザインから、すべてのタイプのAPI定義をエクスポートできます。

既存のAPI定義のインポート

既存のAPI定義がある場合、Talend Cloud API Designerでは以下の形式でインポートできます:

  • OpenAPI仕様3.0
  • OAS/Swagger 2.0
  • OAS/Swagger 1.2
  • RAML 1.0

API定義をプレビュー

エディターの下部のタブを使えば、OAS/SwaggerまたはRAMLでAPIデザインをすばやくプレビューできます。

プレビュータブのスクリーンショット。

完成したAPIをエクスポート

APIのデザインが完了したら、[EXPORT] (エクスポート)メニューを使用して、OAS/SwaggerまたはRAMLをファイルに直接ダウンロードできます。Talend拡張機能を使ってAPI定義をエクスポートすることもできます。