APIドキュメントの共有

APIの開発とデバッグが正常に完了したら、Apidogを使用して、チーム、ステークホルダー、または外部開発者と共有できるプロフェッショナルなドキュメントを簡単に生成できます。

ステップバイステップガイド

APIドキュメントを生成して共有するには、次の手順に従ってください。

ステップ1：Share Docsモジュールにアクセスする

1. Apidogプロジェクトを開きます

2. サイドバーからShare Docsモジュールに切り替えます

ステップ2：新しい共有を作成する

1. Newボタンをクリックして、新しいドキュメント共有を開始します
2. 共有設定ダイアログが開きます

ステップ3：共有設定を構成する

共有設定で次の項目を設定します。

設定	説明	推奨される操作
Name	共有にわかりやすい名前を付けます	プロジェクト名 + バージョンを使用します（例："Pet Store API v1.2"）
Environments	含める環境を選択します	包括的なドキュメントにするため、すべての環境を選択します
Access	表示権限を設定します	対象読者に適したアクセスレベルを選択します


3. Saveをクリックして共有を作成します

ステップ4：ドキュメントにアクセスする

1. 新しい共有が共有一覧に表示されます
2. Openをクリックして、Webブラウザーでドキュメントを表示します
3. ドキュメントは共有可能なURL付きで新しいタブに開きます

ステップ5：ドキュメント機能を確認する

ドキュメントには強力な機能が含まれています。

• インタラクティブAPIエクスプローラー：左側のディレクトリツリーでエンドポイントを移動できます

• Try It Out：ドキュメントから直接ライブリクエストを送信できます

• コード生成：リクエストコードスニペットとデータモデルコードを生成できます

• 環境の切り替え：異なるAPI環境をテストできます

高度なカスタマイズと公開

Apidogでは、ドキュメントに対して追加のカスタマイズを行うことができます。

機能	説明	ユースケース
カスタムレイアウト	ドキュメントの構造と外観を変更します	ブランドの一貫性、ユーザー体験の最適化
カスタムドメイン	独自のドメイン名を使用します	プロフェッショナルな提示、ブランド認知
カスタムURL	覚えやすく意味のあるURLを作成します	マーケティング、簡単な共有、SEO上の利点
アクセス制御	詳細な権限を設定します	社内チーム、外部パートナー、公開アクセス

---

ApidogでAPIを設計、テスト、モック、公開する方法について詳しく学びます。