効果的な API コラボレーションには、シームレスなドキュメント共有が必要です。クイック共有は、即時に利用できるオンラインドキュメントリンクを提供することで、Word ファイルや PDF ファイルをやり取りする非効率さを解消します。この機能により、チーム間の迅速なコミュニケーションが可能になり、アクセス、表示範囲、有効期限を管理しながら、特定の API エンドポイントを共同作業者と共有できます。前提条件#
クイック共有を作成する前に、以下を確認してください。プロジェクトにアクセスできる Apidog アカウントがあること
共有する API エンドポイントまたはドキュメントがあること
（任意）読者がエンドポイントをテストできるようにする場合は、環境が設定されていること
クイック共有の作成#
左サイドバーの Publish Docs モジュールに切り替えます。+New をクリックして、新しいクイック共有を作成します。1 つのプロジェクトは複数のクイック共有をサポートしており、異なる共同作業者に配布できます。チームメンバー全員が、チーム内の誰かが作成したクイック共有を表示できます。設定オプション#
新規共有ダイアログでは、以下のオプションをカスタマイズできます。Title: この共有の名前です。Apidog チーム内でのみ表示され、内部識別に使用されます。共有ドキュメントには表示されません。
Environments: オンラインドキュメントで利用可能な環境を選択します。デフォルトでは、環境は選択されていません。複数の環境を選択できます。選択した環境はドキュメント内で読者に表示され、"Try it out" を使用する際にリクエ スト送信に使用できます。
ドキュメント作成時にクラウドモック環境を選択すると、本番システムに影響を与えることなく API をテストできる簡単なサンドボックス環境を読者に提供できます。
Document content: ドキュメントには、Base URL と Request samples という 2 つの任意コンポーネントがあります。これらをドキュメントに表示するかどうかを選択できます。Base URL: これは環境に設定されているベース URL です。選択した場合、ドキュメント内の各インターフェースには完全な URL が表示されます。選択しない場合、ドキュメント内の URL は "/" で始まります。
Owners: この API ドキュメントの所有者を表示します。
Request samples: リクエストを呼び出すためのサンプルコードを表示するかどうかです。詳細は リクエストサンプル を参照してください。 エンドポイント説明の上に「Last Modified」時刻を表示します。
ドキュメントの末尾に「Last Modified」時刻を表示します。
Allow 'Export', 'Clone' Data: 読 者が OAS/Markdown/HTML/Apidog 形式でデータをエクスポートおよび複製できるようにするかどうかです。
Scope to share: この共有に含める API エンドポイントおよび Markdown を選択します。ディレクトリまたはフィルターで選択し、タグで除外することもできます。また、フォルダー全体を共有することもできます。 Security: このドキュメントへのアクセスにパスワードを要求するかどうか、およびこのドキュメントの有効期限を設定できます。有効期限を選択しない場合、有効期限はありません。
Show API Fields: これらのフィールドをドキュメントに表示するかどうかを設定できます。含まれるもの: Owners、Update time、OperationId、Original link、Authorization Required。
Language: ここでの言語設定は、"Query Params"、"Request samples" など、ドキュメント内の機能に関する固定テキストに影響しますが、API ドキュメント本文に記述されたテキストには影響しません。
CORS Proxy: API ドキュメント上でエンドポイントリクエストを処理するために、CORS プロキシサーバーをデプロイして設定できます。詳細はこちら。 Advanced Settings: Hide 'Try it out' Button や Hide 'Powered by Apidog' などのオプションを設定します。
リクエストサンプル#
共有を作成する際に、リクエストコードサンプルを表示するかどうかを選択できます。
リクエストサンプルをカスタマイズする方法:1.
Settings → Feature settings → Endpoint feature settings → Endpoint fields で、Request samples フィールドを有効にします
2.
Endpoint → Edit で、末尾に Request samples モジュールが表示されます
3.
Custom Request Code Samples をクリックして、希望する言語のサンプルを追加します
フォルダー全体を共有#
クイック共有は Share entire folder をサポートしており、共有後もドキュメントの追加や削除を継続するシナリオに最適です。有効にすると、新しいドキュメントごとに共有設定を調整する必要なく、共同作業者はフォルダー内のすべてのドキュメントに自動的にアクセスできます。Scope to Share セクションで Manual Selection を選択すると、Share entire folder オプションが表示されます。有効にすると、共同作業者はフォルダー内のすべてのドキュメントに自動的にアクセスできます。CORS プロキシ設定#
外部ユーザーと API ドキュメントを共有する場合、ユーザーがブラウザーで直接エンドポイ ントをテストする際に、Cross-Origin Resource Sharing (CORS) の問題が発生することがあります。CORS プロキシは、指定されたプロキシエージェントを介してリクエストをルーティングすることでこの問題を解決し、ブラウザーの CORS 制限を回避してシームレスな API テストを可能にします。CORS プロキシを設定するには、新しい共有ドキュメントを作成する際に設定オプションをクリックします。デフォルトでは、Apidog はすべての共有ドキュメントにわたってエンドポイントリクエストを管理するために Cloud Agent を提供します。CORS プロキシオプション#
ニーズに最も適した CORS プロキシオプションを選択してください。Cloud Proxy: Apidog の Cloud Agent を使用してエンドポイントリクエストを処理します。注: Cloud Agent は内部ネットワーク上のエンドポイントにアクセスできません
Browser Extensions: ユーザーのブラウザーにインストールされたブラウザー拡張機能を使用します。拡張機能を持っていないユーザーには、リクエストを行う前にインストールを促します
No Proxy: リクエストはユーザーのブラウザーから直接送信されます。エンドポイントサーバーが CORS を適切に処理するように設定されていることを確認してください
