このページは Apigee と Apigee ハイブリッドに適用されます。
管理者権限を持つユーザーは、マークダウン ファイルとイメージ ファイルをアップロードして、特定の API の設計、開発、デプロイ、使用に関連する重要な情報を伝達できます。ガイドラインは、マークダウン コンテンツのレンダリング版として表示されます。ガイドラインがアップロードされていない場合は、コンテンツをアップロードするように求められます。
ファイル形式
非公開プレビューでは、zip ファイルのみがサポートされます。
zip ファイルにマークダウン ファイルと画像ファイルを含めることができます。
ランディング ページとして機能する index.md ファイルが必要です。zip ファイルに index.md ファイルが含まれていない場合、index.md ファイルが必要であることを示すエラー メッセージが表示され、アップロードがキャンセルされます。
絶対リンクと相対リンクの両方を使用できます。
API ガイドのディレクトリ:
https://console.cloud.google.com/apigee/apihub/apis/{api}/guide/index.md
マークダウン ヘッダーは、ドキュメント内のリンクを可能にするために適切なアンカータグでレンダリングされます。次に例を示します。
https://console.cloud.google.com/apigee/apihub/apis/{api}/guide/contact.md#on_call
zip ファイルをアップロード
zip ファイルをアップロードして、会社の新しいガイドラインを追加するか、既存のガイドラインを上書きします。
zip ファイルをアップロードするには:
Cloud コンソールで、[API Hub] ページに移動します。
デフォルトでは、[APIs] リストページが表示されます。
- [APIs] リストまたは [My APIs] から、API の行をクリックします。デフォルトでは、[Overview] タブが表示されます。
- [Guide] タブを選択します。
- 次のいずれかを行います。
- 新しく追加: [アップロード] をクリックして、新しい zip ファイルをアップロードします。
- 既存を上書き: [Replace existing] をクリックして zip ファイルをアップロードし、既存のコンテンツを上書きします。
- 確認プロンプトで [続行] または [キャンセル] をクリックします。
すべてのコンテンツを削除する
既存のコンテンツをすべて削除するには:
Cloud コンソールで、[API Hub] ページに移動します。
デフォルトでは、[APIs] リストページが表示されます。
- [APIs] リストまたは [My APIs] から、API の行をクリックします。デフォルトでは、[Overview] タブが表示されます。
- [Guide] タブを選択します。
- [Delete all] をクリックします。
- 確認のプロンプトで [削除] または [キャンセル] をクリックします。