機能概要

API 開発、コミュニケーション、コラボレーションは、APIドキュメントに基づくべきことですが、実際の作業中にWordとPDF 形式でファイルを互いに渡し合っている問題も存在します。このため、チーム間のコミュニケーションの効率を向上させるために、オンラインドキュメントということが提唱されます。

オンラインドキュメントの共有

Apidogでは、現プロジェクトの共有オプションが左側メニューにセットされています。そして、「新しい共有」をクリックし、必要に応じて情報コンテンツを設定します。

文書の言語
パスワード
有効期限
共有 APIの範囲：全てのAPI、選択したAPIのみ、または指定されたタグのAPIのどちらを共有できます。
実行環境：動作環境を選択し、対応するプリフィックスURLを表示できます。選択後、共有されたオンラインドキュメントは実行とデバッグをサポートします。
APIドキュメントの担当者、変更時間、対応するURLを表示できます。

ディレクトリ全体を共有する

オンラインドキュメントは、ディレクトリ全体の共有をサポートしています。対応するディレクトリを選択して「ディレクトリ全体を共有」をオンにすると、当該ディレクトリに何か変更があっても、自動的にオンラインドキュメントに同期されます。もちろん、変更をリアルタイムで同期させたくない場合は、有効にしないことを選択できます。