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

ここに表示されているのは Apigee Edge のドキュメントです。
Go to the Apigee X のドキュメントに移動します
info

2015 年 6 月 2 日(火)に、Apigee デベロッパー サービス ポータルの新しいクラウド バージョンをリリースしました。

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

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 管理 サービス内にある 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 Monetization の日付形式を管理者が構成できるようにする
日付形式は、Monetization のヨーロッパと米国の日付形式の収益化設定で構成できるようになりました。
DEVSOL-603 競合プラン ページの形式が正しくない
既存のプランと重複するプランを購入する場合に表示されるページが、ユーザー向けに適切にフォーマットされるようになりました。
DEVSOL-642 クライアント レベルの構成をセキュリティ設定からテンプレート 設定に移動する
DEVSOL-709 SmartDocs: 空の値でリクエストを送信した後、URL テンプレート パラメータを編集できない
メソッド ドキュメントでテンプレート パラメータを削除した後、SmartDocs からリクエストを送信するとテンプレート パラメータを編集できなくなる問題を修正しました。
DEVSOL-1013 デベロッパー ポータルのユーザーのメールアドレスを編集可能にする
プロフィールの編集ページのメールアドレス フィールドが無効にならなくなり、 デベロッパーはメールアドレスを変更できるようになりました。
DEVSOL-1273 [Modules] リストに「DevConnect Mint」が 2 回表示される
[Modules] に「Dev Connect Mint」が 2 回表示されていました。この問題は解決しました。
DEVSOL-1313 Swagger と WADL の両方で JSON/YAML ファイルまたは URL のインポートをサポートする
WADL ファイルを URL 経由でインポートできるようになり、Swagger ファイルをアップロードできるようになりました。
DEVSOL-1339 SmartDocs 管理メニューの場所を変更する
SmartDocs は [Content] メニューに移動し、SmartDocs の設定は [Settings] 管理メニューに移動しました。
DEVSOL-1340 [一般提供版に移行する際にベータ版を削除する]
SmartDocs は [Content] メニューに移動し、SmartDocs の設定は [Settings] 管理メニューに移動しました。
DEVSOL-1390 PHP SDK Edge ライブラリが更新され、 __toString()
PHP SDK Edge ライブラリが更新され、DeveloperRatePlan オブジェクトで __toString() を呼び出すとエラーが発生する問題が修正されました。{quote} Fatal error: Call to a member function format() on a non-object in /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php on line 221 {quote} これは、toString() メソッドを呼び出すカスタムコードを使用している Monetization のお客様にのみ影響するバグです。
DEVSOL-1398 SmartDocs Petstore モデルが、ユーザーに確認することなくインストール時にインポートされる
SmartDocs は、SmartDocs の使用例をより包括的に示すために、天気モデルではなく、サイトのインストール時に Petstore Swagger の例(http://petstore.swagger.io/v2/swagger.json)をインポートするようになりました。
DEVSOL-1407 デベロッパーが多いと Cron が失敗する
Drupal Cron を実行すると、デベロッパーの数が多いためにタイムアウトが発生していました。組織に 200 人を超えるユーザーがいる場合は、バッチ処理が使用されるようになりました。
DEVSOL-1470 [**APIs] メニューリンクと対応するビューを作成する
デベロッパー ポータルの SmartDocs には、デフォルトで [APIs] という名前のメインメニューに SmartDocs レンダリング ドキュメントへのリンクが用意されています。このリンクは、公開されたメソッドを含むモデルにリンクします。

既知の問題

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

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

これでノードが正しくレンダリングされるようになります。