15.05.27.00 - Apigee Developer Services ポータル リリースノート

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。 情報

2015 年 6 月 2 日（火）に、Apigee Developer Services ポータルの新しいクラウド バージョンをリリースしました。

ご不明な点がございましたら、Apigee カスタマー サポートにお問い合わせください。

Apigee Edge のすべてのリリースノートの一覧については、Apigee リリースノートをご覧ください。

新機能

SmartDocs の一般提供

SmartDocs のベータ版テストが終了し、一般提供が開始されます。更新と新機能は次のとおりです。

  • Swagger 2.0 のサポート（ファイルまたは URL によるインポートなど）、カスタム名のセキュリティ オブジェクトのサポート。
  • SmartDocs を生成するテンプレートのビジュアル デザインを改善しました。
  • デベロッパー ポータルのユーザビリティとワークフローの改善。Drupal の [Content] > [SmartDocs] メニューから利用できます。
  • 「カスタム トークン」認証は「API キー」に名称が変更されました。
  • リビジョン レベルで定義された認証「セキュリティ」オブジェクト。
  • テンプレート レベルでのクライアント認証の構成。新しいリビジョンで、事前構成された SmartDocs クライアント認証情報がリセットされなくなりました。

その他の機能の説明については、こちらのブログ投稿をご覧ください。

SmartDocs のドキュメントについては、SmartDocs を使用した API のドキュメント化をご覧ください。

SmartDocs のアップグレード プロセス

ベータ版期間中に SmartDocs をすでに使用している場合は、一般提供版の新しい機能を使用するには、デベロッパー ポータルで SmartDocs をアップグレードする必要があります。

デベロッパー ポータルですでに公開されている SmartDocs ページは引き続き機能しますが、既存または新しいページの変更を編集または公開する前に、更新プロセスに沿って操作する必要があります。

デベロッパー ポータル内で SmartDocs をレンダリングして公開することはできますが、SmartDocs は Apigee の Edge API Management サービス内に存在する API モデルから生成されます。Edge の API モデルに加えた変更は、すべての Pantheon 環境で同じになります（Pantheon 環境全体に開発者が存在する仕組みに似ています）。

SmartDocs ベータ版から一般提供にアップグレードする

  1. Pantheon のdev 環境またはtest 環境で 15.05.27 リリースを更新してテストします。
  2. 使用している既存の API モデルに代わる新しいモデルを作成します。
    • Swagger ドキュメントまたは WADL ドキュメントをインポートしている場合は、新しいリビジョンに再度インポートします。
    • SmartDocs モジュールを使用して API モデルを維持している場合は、SmartDocs JSON としてエクスポートし、ファイル アタッチメントを使用して新しいモデルにインポートします。
  3. モデルのリビジョンのセキュリティ プロパティを設定します。[Content > SmartDocs > model] ページで、[Security Settings] を選択します。
  4. モデル設定ページ（[Content] > [SmartDocs]）で、[Operations] 列の [Settings] をクリックして、事前構成された認証を確認します。
  5. カスタム テンプレートを更新して CSS アセットと JS アセットの v6 を使用し、authSchemes や apiSchema などの新しいオブジェクト名を反映するように変更します。SmartDocs テンプレートの更新については、SmartDocs を使用した API のドキュメント化をご覧ください。
  6. モデル リビジョンを再レンダリングして公開します。
  7. 新しいドキュメントを検証したら、本番環境ポータルを 15.05.27 リリースに更新します。

Edge Enterprise をご利用で、アップグレード プロセスについてご不明な点やご懸念がある場合は、marsh@apigee.com と cnovak@apigee.com までメールでお問い合わせください。それ以外の場合は、Apigee コミュニティで最適な回答をご確認ください。

修正済みのバグ

このリリースでは以下のバグが修正されています。

問題 ID 説明
DEVSOL-487 収益化の日付形式を管理者が設定可能に
日付形式を、収益化の設定でヨーロッパと米国の日付形式に設定できるようになりました。
DEVSOL-603 競合するプランのページの形式が不適切
既存のプランと重複するプランを購入する際、表示されるページの形式がユーザーにとって適切になりました。
DEVSOL-642 クライアント レベルの構成をセキュリティ設定からテンプレート設定に移動する
DEVSOL-709 SmartDocs: 空の値でリクエストを送信した後に URL テンプレート パラメータを編集できない
メソッドのドキュメントでテンプレート パラメータを削除した後、SmartDocs からリクエストを送信すると、テンプレート パラメータを編集できなくなる問題を修正しました。
DEVSOL-1013 デベロッパー ポータルのユーザーのメールアドレスを編集可能に
プロフィール編集ページのメールアドレス フィールドが無効化されなくなり、デベロッパーはメールアドレスを変更できるようになります。
DEVSOL-1273 [モジュール] リストに「DevConnect Mint」が 2 回表示される
[モジュール] に「Dev Connect Mint」が 2 回表示されました。この問題は解決しました。
DEVSOL-1313 Swagger と WADL の両方で JSON/YAML ファイルまたは URL のインポートをサポート
WADL ファイルを URL 経由でインポートし、Swagger ファイルをアップロードできるようになりました。
DEVSOL-1339 SmartDocs 管理メニューの場所を変更
SmartDocs はコンテンツ メニューの下に移動され、SmartDocs の設定は設定管理メニューの下に移動されました。
DEVSOL-1340 一般提供に移行する際に「ベータ版」を削除
SmartDocs はコンテンツ メニューの下に移動され、SmartDocs の設定は設定管理メニューの下に移動されました。
DEVSOL-1390 PHP SDK Edge ライブラリが更新され、__toString() の呼び出しに関する問題が修正されました
PHP SDK Edge ライブラリが更新され、DeveloperRatePlan オブジェクトで __toString() を呼び出す問題が修正されました。この問題により、次のようなエラーが発生します。{quote} 致命的なエラー: /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php の 221 行目で、オブジェクト以外のメンバー関数 format() を呼び出しています {quote} これは、toString() メソッドを呼び出すカスタムコードを使用する収益化のお客様にのみ影響するバグです。
DEVSOL-1398 ユーザーにプロンプトを表示せずにインストール時に SmartDocs Petstore モデルをインポート
SmartDocs の使用例をより網羅的に提供するため、サイトのインストール時に、天気モデルではなく、petstore swagger の例（http://petstore.swagger.io/v2/swagger.json）がインポートされるようになりました。
DEVSOL-1407 デベロッパーが多いと Cron が失敗する
Drupal cron の実行時に、大量のデベロッパーがタイムアウトの問題を引き起こしました。組織のユーザー数が 200 を超える場合、バッチ処理が使用されるようになりました。
DEVSOL-1470 [API] メニュー リンクと対応するビューを作成
デベロッパー ポータルの SmartDocs に、デフォルトで [API] という名前のメインメニューに、レンダリングされた SmartDocs ドキュメントへのリンクが追加されました。このリンクは、公開されたメソッドを含むモデルにリンクします。

既知の問題

このリリースには、次の既知の問題があります。

問題 ID 説明
DEVSOL-1558
新規インストールで Petstore の例の SmartDocs メソッド ページが正しくレンダリングされない
SmartDocs の Petstore メソッドの例のページが、新規インストールで正しくレンダリングされない。この問題を解決するには:
  1. Drupal メニューで、[Content] > [SmartDocs] を選択します。
  2. [Petstore Example] モデルを選択します。
  3. [Update Options] で [Render and publish nodes] を選択します。
  4. [すべて選択 / 選択解除] チェックボックスをオンにして、すべてのノードを選択します。
  5. [更新] をクリックします。

これでノードが正しくレンダリングされるはずです。