APIドキュメンテーション
Talend Cloud API Designerを使ってAPIをドキュメント化できます。
ドキュメント化は、APIのライフサイクルにおける重要なステップです。ドキュメントの作成と保守は困難な作業になり得ますが、Talend Cloud API Designerではドキュメントを自動的に取得できます。
誰がドキュメンテーションを書き、誰がそれを読みますか？
Talend Cloud API Designerでは、APIデザインの編集を許可されているAPI Designerのチームが作業します。チームメンバーは、APIのドキュメントに寄稿してライブプレビューを生成できます。
ライブドキュメンテーションは、チームメンバー、パートナー、または開発中にアクセスが必要となるユーザーと共有できます。
APIドキュメントを公開する準備ができたら、API Portalに公開できます。詳細は、API Portalを公開をご覧ください。
このページは役に立ちましたか?
このページまたはコンテンツに、タイポ、ステップの省略、技術的エラーなどの問題が見つかった場合は、お知らせください。改善に役立たせていただきます。