1.3. ネイティブデベロッパーポータルを変更するための追加の 3scale 機能の説明

3scale は、専用のデベロッパーポータルを作成するための、ネイティブのデベロッパーポータルをカスタマイズする多くの機能を提供します。

開発者ポータルの開発中、開発者ポータルを表示する必要のあるメンバーは、アクセスコードを指定する必要があります。API プロバイダーが API 利用者に開発者ポータルへのアクセスを公開するために必要なタスクを実行している間、このアクセスコードを使用し続けます。このアクセスコードを使用することで、ご自分やこのコードを持つメンバーだけが開発者ポータルを表示できるようになります。アクセスコードは Domains & Access ページにあります。このページは、管理ポータルでAudience > Developer Portal > Domains & Access の順に選択して表示できます。

以下のリストで、ネイティブ開発者ポータルを変更するための機能の一部を紹介します。

  • Developer Portal > Content 環境では、右上の New Page ドロップダウンにより、開発者ポータルに以下の要素を追加できます。

    • Page - 開発者ポータルのコンテンツの基本単位。
    • layout: 複数のページが使用できるテンプレート。
    • partial: 他のパーシャル、レイアウト、およびページ内で再利用できるコンテンツ。
    • Section: ディレクトリーと機能的に同等です。開発者ポータルのコンテンツを整理するためのセクションを作成します。
    • File: スタイルシート、イメージ、スクリプトなど、開発者ポータルで使用するリソース。
    • Portlet: 外部 RSS フィード、目次、または最新のフォーラム投稿。
  • HTML、Markdown、または Textile でコードを入力できます。コードエディターは、コードの強調表示、表作成、行番号、その他の機能をサポートします。

  • ページのドラフトまたは公開バージョンをプレビューできます。ページのテキストエディターの下で、Preview をクリックすると開発者ポータルの開発バージョンが表示されます。

    プレビューには、右側に濃いグレーの垂直バーが表示されます。濃いグレーのバーの上部で Draft | Published のいずれかが強調表示され、表示しているバージョンが示されます。このバーには、以下の項目の編集環境へのリンクが含まれます。

    • ページ。
    • ページが使用するレイアウト。
    • ページが使用するパーシャル。パーシャルとは、異なるページの多くの場所で再利用できるコードのことです。

    開発者ポータルの開発バージョンの Draft ビューは、イテレーティブ/差分の改善をサポートします。Draft バージョンの見栄えおよび動作が正しかったら、公開できます。アクセスコードを使用すると、ページを公開すると、開発者ポータルが公開された場合に API 利用者にどのように見えるかを確認できます。アクセスコードが使用されない場合、ページを公開すると、ライブの開発者ポータルでそのページが更新されます。

  • フィルターフィールドを使用すると、開発者ポータル環境のリソースを検索できます。3scale は、検索対象の要素のみを表示するので、作業対象を簡単に見つけることができます。フィルターフィールドは、アイコンのすぐ下にあります。

    Developer Portal filter field
  • Developer Portal > Redirects ページでは、ある開発者ポータル URL から別の開発者ポータル URL へのリダイレクトを設定できます。たとえば、作成したページを非推奨にした場合は、リクエストを新しいページにリダイレクトすることができます。

  • プレースホルダーは編集可能なフィールドです。たとえば、開発者ポータル > コンテンツ > ログイン > 新規 ページには、いくつかのプレースホルダーがあります。 

    <input id="session_username" name="username" tabindex="1"
  autofocus="autofocus" type="text"
  placeholder="Authenticate with your email"
  class="form-control">
...
<input id="session_password" name="password" tabindex="2"
  type="password"
  placeholder="…and password"
  class="form-control">

    このコードは、開発者ポータルで次のフィールドを生成します。

    開発者ポータルのプレースホルダーフィールド

    プレースホルダーテキストを更新して公開し、開発者ポータルで更新を確認できます。たとえば、Authenticate with your email を Authenticate email に変更できます。ページを公開すると、開発者ポータルで更新されたプロンプトを確認できます。次に例を示します。

    開発者ポータルの更新されたプレースホルダーフィールド