現在、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 キー」に名称変更されました。
- リビジョン レベルで定義されている認証「security」オブジェクト。
- テンプレート レベルでのクライアント認証の構成。新しいリビジョンで、事前構成された SmartDocs クライアント認証情報がリセットされなくなります。
機能の詳細については、こちらのブログ投稿をご覧ください。
SmartDocs のドキュメントについては、SmartDocs を使用した API のドキュメント化をご覧ください。
SmartDocs のアップグレード プロセス
ベータ版の期間中に SmartDocs をすでに使用している場合は、一般提供バージョンの新機能を使用するために、デベロッパー ポータルで SmartDocs をアップグレードする必要があります。
デベロッパー ポータルですでに公開されている SmartDocs ページは引き続き機能しますが、既存または新規のページに対する変更を編集または公開する前に、更新プロセスに従う必要があります。
デベロッパー ポータル内で SmartDocs をレンダリングして公開することはできますが、SmartDocs は Apigee の Edge API Management Services 内に存在する API モデルから生成されることに注意してください。Edge で API モデルに加えた変更は、すべての Pantheon 環境で同じになります(開発者が Pantheon 環境にまたがる場合と同様です)。
SmartDocs ベータ版から一般提供版にアップグレードするには
- Pantheon の dev または test 環境で 15.05.27 リリースを更新してテストします。
- 新しいモデルを作成して、使用している既存の API モデルと置き換えます。
- Swagger ドキュメントまたは WADL ドキュメントをインポートしている場合は、新しいリビジョンに再度インポートします。
- SmartDocs モジュールを使用して API モデルを保守している場合は、SmartDocs JSON としてエクスポートし、添付ファイルを使用して新しいモデルにインポートします。
- モデルのリビジョンのセキュリティ プロパティを設定します。[Content] > [SmartDocs] > [model] ページで、[Security Settings] を選択します。
- モデルの設定ページ([Content] > [SmartDocs])で事前構成済みの認証を確認します。それには、[Operations] 列の [設定] をクリックします。
- CSS アセットと JS アセットの v6 を使用するようにカスタム テンプレートを更新し、authSchemes や apiSchema などの新しいオブジェクト名を反映するように変更を加えます。SmartDocs テンプレートの更新については、SmartDocs を使用した API のドキュメント化をご覧ください。
- モデル リビジョンを再レンダリングして公開します。
- 新しいドキュメントを検証したら、本番環境ポータルを 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 | [Modules] リストに「DevConnect Mint」が 2 回表示される [Modules] に「Dev Connect Mint」が 2 回表示される。この問題は解決しました。 |
DEVSOL-1313 | Swagger と WADL の両方で、JSON/YAML ファイルまたは URL のインポートをサポート WADL ファイルは URL 経由でインポートできるようになり、Swagger ファイルをアップロードすることもできます。 |
DEVSOL-1339 | [SmartDocs Admin] メニューの場所を変更する SmartDocs がコンテンツ メニューの下に、smartdocs 設定が設定管理メニューの下にあります。 |
DEVSOL-1340 | 一般提供への移行時にベータ版を削除する SmartDocs がコンテンツ メニューに表示され、smartdocs 設定が設定管理メニューに表示されるようになりました。 |
DEVSOL-1390 | |
DEVSOL-1398 | SmartDocs Petstore Model のインポート時にユーザーにプロンプトが表示されることなくインポート SmartDocs は、サイトのインストール時に、天気モデルではなく petstore swagger の例(http://petstore.swagger.io/v2/swagger.json)をインポートするようになりました。これにより、SmartDocs の使用例を包括的に確認できます。 |
DEVSOL-1407 | 開発者の数が多い場合、cron が失敗する Drupal cron を実行する際に、多くの開発者でタイムアウトの問題が発生しました。組織のユーザー数が 200 を超える場合は、バッチ処理が使用されるようになりました。 |
DEVSOL-1470 | [API] メニューリンクと対応するビューの作成 デベロッパー ポータルの SmartDocs には、メインメニューの [APIs] に SmartDocs でレンダリングされたドキュメントへのリンクがデフォルトで表示されるようになりました。これにより、公開済みのメソッドを持つすべてのモデルにリンクされます。 |
既知の問題
このリリースには、次の既知の問題が含まれています。
問題 ID | 説明 |
---|---|
DEVSOL-1558 |
Petstore Example SmartDocs メソッドのページが新規インストールで正しくレンダリングされません
SmartDocs 内のサンプルの Petstore メソッドのページは、新規インストールで正しくレンダリングされません。この問題の解決方法は次のとおりです。
ノードが正しくレンダリングされるはずです。 |