API開発、コミュニケーション、コラボレーションにおいて、APIドキュメントは論理的には標準ですが、実際にはWordやPDF形式のファイルをやり取りする問題があります。このため、チーム間のコミュニケーション効率を向上させるためにオンラインドキュメントが推奨されています。クイックシェアを作成する#
左側のShare Docsモジュールに切り替えます。+Newをクリックして新しいクイックシェアを作成します。プロジェクトは複数の異なるクイックシェアをサポートしており、異なるコラボレーターに配布できます。チームメンバー全員が、すべてのクイックシェアを確認できます。新しいシェアのポップアップで、以下のオプションをカスタマイズできます：Title: このシェアの名前で、Apidogチーム内でのみ表示され、内部識別用であり、共有ドキュメントには表示されません。
Environments: オンラインドキュメントで利用可能な環境を選択します。デフォルトでは環境は選択されていません。複数の環境を選択できます。選択した環境はドキュメント内で読者に表示され、「試してみる」機能を使用する際にリクエストを送信するために使用できます。
ドキュメント作成時にCloud mock環境を選択すると、ドキュメントの読者に対してシンプルなサンドボックス環境を有効にすることと同等です。
Document content: ドキュメントには、Base URLとRequest samplesの2つのオプションコンポーネントがあります。ドキュメントに表示するかどうかを選択できます。Base URL: 環境で設定されたベースURLです。選択すると、ドキュメント内の各インターフェースに完全なURLが表示されます。選択しない場合、ドキュメント内のURLは「/」で始まります。
Owners: このAPIドキュメントの所有者を表示します。
Request samples: リクエストを呼び出すためのサンプルコードを表示するかどうか。詳細はrequest samplesを参照してください。 エンドポイントの説明の上に「最終更新日時」を表示します。
ドキュメントの最後に「最終更新日時」を表示します。
Allow 'Export', 'Clone' Data: 読者がOAS/Markdown/HTML/Apidog形式でデータをエクスポートおよびクローンすることを許可するかどうか。
Scope to share: このシェアに含めるAPIエンドポイントとMarkdownを選択します。ディレクトリで選択したり、タグでフィルタリングして除外したりできます。また、フォルダ全体を共有することも選択できます。 Security: このドキュメントにアクセスするためにパスワードが必要かどうか、およびこのドキュメントの有効期限を設定できます。有効期限が選択されていない場合、期限切 れにはなりません。
Show API Fields: ドキュメントにこれらのフィールドを表示するかどうかを設定できます。含まれるもの：所有者、更新日時、OperationId、オリジナルリンク、認証が必要かどうか。
Language: ここでの言語設定は、ドキュメント内の機能固定テキスト（例：「Query Params」「Request samples」など）に影響しますが、APIドキュメントの内容に書かれたテキストには影響しません。
CORS Proxy: APIドキュメント上でエンドポイントリクエストを処理するためにCORSプロキシサーバーをデプロイおよび設定できます。詳細はこちら。 Advanced settings: ここで「試してみる」ボタンを非表示にする設定や「Powered by Apidog」を非表示にする設定を行えます。
Request samples#
シェアを作成する際に、このモジュールを表示するかどうかを選択できます。
Request samplesをカスタマイズできます。方法は以下の通りです：1.
Project settings - Feature settings - Endpoint feature settings - Endpoint fieldsでRequest samplesフィールドを有効にします。
2.
次にEndpoint - Editで、Request samplesモジュールが最後に表示されます。
3.
ここでAdd request sampleをクリックして、必要な言語でサンプルを追加できます。すると、ドキュメントに表示されます。
フォルダ全体を共有する#
クイックシェアはShare entire folderをサポートしています。これは、リンクを共有した後にフォルダ内のドキュメントを追加または削除した場合に、コラボレーターがこれらの変更を同期的に確認できるシナリオに適しています。Scope to ShareでManual Selectionを選択すると、Share entire folderが表示されます。有効にすると、コラボレーターはフォルダ内のすべてのドキュメントに自動的にアクセスできるようになり、新しいドキュメントを追加するたびに共有設定を調整する必要がなくなります。CORS Proxy#
外部ユーザーとAPIドキュメントをオンラインで共有する際、ユーザーはドキュメント内でエンドポイントを直接テストまたはデバッグしたい場合があります。しかし、これはブラウザでクロスオリジンリソース共有（CORS）問題を引き起こし、リクエストがブロックされる可能性があります。これを解決するために、CORSプロキシを設定できます。このプロキシは、共有ドキュメントからのすべてのエンドポイントリクエストを指定されたリクエストプロキシエージェントを通じてルーティングし、CORS制限を効果的に回避してシームレスなデバッグを可能にします。CORSプロキシを設定するには、新しい共有ドキュメントを作成する際に設定オプションをクリックするだけです。デフォルトで、ApidogはCloud Agentを提供して、すべての共有ドキュメント間でエンドポイントリクエストを管理します。ニーズに最適なCORSプロキシオプションを選択します：Cloud Agent: これはApidogのCloud Agentを使用して、共有 ドキュメントからのエンドポイントリクエストを処理します。Cloud Agentは内部ネットワーク上のエンドポイントにアクセスできないことに注意してください。
Browser Extensions: このオプションは、ユーザーのブラウザにインストールされたブラウザ拡張機能を使用してリクエストを処理します。ユーザーが拡張機能をインストールしていない場合、エンドポイントリクエストを開始する前にインストールするように促されます。
No Proxy: このオプションを選択すると、リクエストはユーザーのブラウザから直接エンドポイントに送信されます。エンドポイントサーバーの設定がCORSを処理できるように正しく構成されていることを確認し、潜在的な問題を防ぎます。
Self-hosted Request Proxy Agent: これは、チーム内にデプロイされたリクエストプロキシエージェントを使用して、共有ドキュメントからのエンドポイントリクエストを処理することを可能にします。 リンクを共有する#
設定が完了したら、リンクをコピーしてチームメンバーと共有します。 
