1.6. 3scale 管理の API のネイティブデベロッパーポータルのカスタマイズに関する考慮事項
ネイティブデベロッパーポータルをカスタマイズして独自のデベロッパーポータルを作成する前に、基本要素、再利用可能なコンテンツ、ページ階層、ページヘッダー/フッター、およびブランディングを計画する必要があります。
基本的なデベロッパーポータル要素: デベロッパーポータルのプランには、以下を含める必要があります。
- サイトマップ: ポータルがどのように設定されているかのスケルトン。
- 上部のメニューバー: 各ページで繰り返されるナビゲーション。
- サイドメニューバー: 各セクションの個々のページへのアクセス。
- ページレイアウトのガイドライン: 一貫したルックアンドフィール用。
- 再利用可能なコンテンツ: レイアウトとパーシャルにより、デベロッパーポータルの一貫性が確保されます。ページの作成を開始する前に、作成します。
ページ階層: サイトマップのルートレベルで開始し、トップメニュー項目ごとにセクションを作成します。
次に、各トップメニュー項目に必要なページを作成します。ページを作成する際には、必ず正しいセクションに関連付けてください。これにより、デベロッパーポータルの URL パスに対して一貫性のある設定が作成されます。Textile や Markdown などのマークアップ言語でページをコーディングするには、ページの ADVANCED OPTIONS を展開します。Handler フィールドはマークアップ言語を識別します。
- ページヘッダーとフッター: 通常、繰り返し表示されるページ要素はパーシャルで定義されます。レイアウトが少しだけの場合、パーシャルではなくレイアウトで直接ヘッダーとフッターを定義する方が望ましい場合があります。
ブランディング: デフォルトのネイティブデベロッパーポータルスタイルシート
default.cssは大きく複雑です。このスタイルシートを拡張するのではなく、デフォルトを上書きするカスタム設定の専用のスタイルシートを作成します。ページの作成と同じ方法で、新しいスタイルシートを作成することができます。高度なページ設定で css セクションと適切な MIME コンテンツタイプを選択します。レイアウトで
default.cssへのリンクの後に、カスタムスタイルシートへのリンクを追加します。たとえば、my-custom.cssを作成する場合は、以下を挿入します。<link rel="stylesheet" href="/css/my-custom.css" />
変更できない組み込み機能には、次のものがあります。
- ページネーション
- メッセージメニュー
- フォーラム - レイアウトのみを変更できます。
- お支払い - これらのページでは、いくつかのテキストフィールドのみが編集できます。
