APIドキュメンテーション - Cloud

Talend Cloud API Designerユーザーガイド

Version
Cloud
Language
日本語
Product
Talend Cloud
Module
Talend API Designer
Content
ジョブデザインと開発 > Designing APIs
Last publication date
2024-03-13
Talend Cloud API Designerを使ってAPIをドキュメント化できます。 ドキュメント化は、APIのライフサイクルにおける重要なステップです。ドキュメントの作成と保守は困難な作業になり得ますが、Talend Cloud API Designerではドキュメントを自動的に取得できます。

誰がドキュメンテーションを書き、誰がそれを読みますか?

Talend Cloud API Designerでは、APIデザインの編集を許可されているAPI Designerのチームが作業します。チームメンバーは、APIのドキュメントに寄稿してライブプレビューを生成できます。

ライブドキュメンテーションは、チームメンバー、パートナー、または開発中にアクセスが必要となるユーザーと共有できます。

APIドキュメントを公開する準備ができたら、API Portalに公開できます。詳細は、API Portalを公開をご覧ください。