ポータル構築のベスト プラクティス

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する。

ポータルを構築する際は、以下のセクションに示すベスト プラクティスを適用することをおすすめします。

対象ユーザーの関心を引く

対象ユーザーに視覚的に訴えかけ、もっと知りたいと思わせるようなコンテンツを追加します。ポータルの一部は API ユーザーがログインしなくても閲覧できるようにします。API ユーザーがすぐに API を使用してアプリの開発を始められるように、セルフサービスの登録を提供します。

ユーザーが API を試せるようにする

OpenAPI 仕様からインタラクティブな API ドキュメントを自動生成します。ユーザーはこのページで次のことができます。

• API について学ぶ
• API へのライブ リクエストの送信

• API から返された実際のレスポンスの表示

  詳細については、API の公開をご覧ください。

主な学習プログラムに取り組む

対象ユーザーの経験レベルに応じて、関連する使用事例やチュートリアルを提供します。単純な curl コマンドなどの例を使って具体的に説明するか、より詳細な手順を段階を追って示します。

検索エンジン最適化（SEO）を実施する

コンテンツを確実に検索可能にします。SEO に投資して検索結果のランキングを上昇させ、ユーザーがポータルのコンテンツを見つけられるようにします。

コンテンツを構造化するときは、次のベスト プラクティスを使用します。詳細と Google による追加ガイドラインについては、Google 検索エンジン最適化（SEO）スターター ガイドをご覧ください。

ベスト プラクティス	説明	利点
ユーザー フレンドリーな URL を作成する	簡潔で人が見て意味のわかる URL を作成します。ポータルサイトにページを追加するときは、ページの作成で説明するように、ユーザーフレンドリーな URL をページに付けます。	人間が読める形式でページの目的を示します。 ページ URL に対するキーワードの完全一致または部分一致により、検索ランキングが上昇します。 通常、URL は検索結果に表示されます。
わかりやすいポータル名を付ける	ポータルの管理で説明されているように、ポータルに一意の説明的な名前を付けます。この内容は、ポータルのホームページ（index）の <title> タグを挿入するために使用されます。	タイトルに対するキーワードの完全一致または部分一致により、検索ランキングが上昇します。 通常、ページタイトルの内容は検索結果の最初の行に表示されます。
サイト内を移動しやすくする	ナビゲーションを設定するで説明するように、論理的に理解できるナビゲーション構造を定義します。	常にユーザーの目線に立ちます。 ユーザーが必要なコンテンツをすばやく簡単に見つけられるようになります。
キーワード フレーズをうまく組み合わせてコンテンツ全体に配置する	コンテンツ内の適切で意味のある箇所にキーワードを含めます。あるキーワード文字列がページで顕著に使用されていると、検索結果のページ ランキングが上昇する可能性があります。ユーザーがポータルのコンテンツを検索するときに使用する可能性があるキーワード文字列を予測してみます。ただし、「キーワード スタッフィング」にならないように注意します。つまり、検索ランキングを上昇させるためだけにキーワードを過剰に使用することは避けます。キーワード スタッフィングを行っていると判断されたサイトは、検索エンジンによってペナルティが課される場合があります。	ユーザーが関連する検索を行ったときにヒットする可能性が高くなります。

デベロッパー コミュニティを構築する

ソーシャル メディアを利用し、Facebook や Twitter などの一般的なソーシャル チャネルを通じて API コミュニティを振興します。ブログの投稿やフォーラムの開催により、API コミュニティに関わるデベロッパーの間のコミュニケーションやインタラクションを促進します。