Developer Portal Menu Management
概要
このチュートリアルでは、Developer Portalのナビゲーションメニュー構造の管理方法を説明します。トップナビゲーションバーのための多層メニューを構成し、各項目をコンテンツやURLにリンクさせ、ターミナルメニューのノード用に詳細なHTMLベースのページを作成できます。この構造は最大3レベルの深さをサポートします。
前提条件
メニュー管理にアクセスするには:
- 管理者アクセス権が必要です
- 次に進んでください: Admin > Menu Management
ステップバイステップチュートリアル
ステップ 1. メニュー階層を理解する
メニューは複数のレベルで構成されています:
- レベル 1: トップナビゲーション(例:製品、アプリケーション、ドキュメント、フォーラム)
- レベル 2: サブメニューグループ(例:すべてのAPI、ペンテスト)
- レベル 3: ターミナルノード(例:Ver.1、ガイド)、ここにコンテンツを追加できます
レベル3のメニューのみが編集可能なコンテンツページを持つことができます。
ステップ 2. メニュー項目の追加または編集
A. 新しいメニュー項目を追加するには:
- 希望する親メニューの横にある + アイコンをクリックします
- メニュータイトルを入力します(例:ユーザーガイド)
- 可視性を選択します(表示 / 非表示)
- 登録をクリックします
B. 既存の項目を編集するには:
- メニューの横にある鉛筆アイコンをクリックします
- 名前を変更するか、必要に応じて順序を入れ替えます
- 保存をクリックして適用します
ステップ 3. メニューコンテンツを書くまたは編集する(レベル3のみ)
ターミナルノードのコンテンツを編集するには:
- Document > Ver.1のようなメニューを選択します
- 右側のペインに次のように入力します:
Field | Example |
---|---|
タイトル | Ver. 1 |
可視性 | チェック済み |
コンテンツ | リッチテキスト(HTMLエディタ) |
リッチコンテンツの例:
# API オンボーディングプロセス
## 1. アプリケーションを登録する
**Application > My Applications** セクションでアプリケーションにサインアップして登録します。
## 2. IPリファラーを設定し、アクセスをリクエストする
IPリファラーを構成し、**Application > My Applications > API Usage**を通じてAPI使用リクエストを送信します。
## 3. APIをテストして使用する
承認されたら、**Test**タブでAPIをテストするか、実際の使用を開始します。
## 4. チームメンバーを管理する
**Application > My Applications > Members**で登録したアプリケーションにチームメンバーを追加します。
画像やファイルを追加する:
- 画像を追加するボタンまたはファイルを追加するボタンを使用します
- アップロードされたファイルはエディタの下に表示され、コンテンツに添付可能です
エディタはヘッダー、フォーマット、リンク、テーブル、インラインHTMLをサポートしています。
ステップ 4. メニューコンテンツを保存する
- 編集が完了したら、コンテンツペインの下部にある保存ボタンをクリックします
- Developer Portalを訪問した際にコンテンツが正しく表示されることを確認します
ベストプラクティス
- APIやガイドを整理するために明確で階層的な構造を使用します
- ドメインや製品ライン(例:/AI、/Security、/OpenAPI)ごとにAPIリファレンスをグループ化します
- メニュータイトルは簡潔に保ちます(可読性のために25文字以内)
- HTMLエディタを使用して、ヘッダー、リンク、スタイリングで可読性を向上させます
- 定期的にリンク切れや古いコンテンツを確認します