Red Hat Summit第14章 開発者ポータルのエクスポートおよびインポート
3scale API プロバイダーは、以下の目的で開発者ポータルをエクスポートおよびインポートできます。
- バックアップの作成。
- 開発者ポータルの外部リポジトリー (GitHub など) での管理。
- 開発者ポータルと他のアプリケーションの統合。
開発者ポータル API をコンテンツ管理システム (CMS) として使用して、開発ポータルのコンテンツをインポートおよびエクスポートします。このためには、次の手順を実行して、開発者ポータル API を使用する権限を使用してキーを生成します。
手順
- Account settings > Personal > Tokens に移動し、Add Access Token をクリックします。
- アクセストークンに名前を付け、Developer Portal API を確認します。
権限を選択します。
- Read Only では、開発者コンテンツポータルのコンテンツを取得できます。
- Read and Write では、開発者ポータルのコンテンツの取得と復元が可能になります。
- Create Access token をクリックします。
- 表示されるトークン情報をコピーして保存します。
左側のパネルから Integrate > 3scale API Docs にナビゲートするエンドポイントリストを確認します。次に、Developer Portal API まで下にスクロールします。生成されたトークンを使用して各エンドポイントを起動し、必要に応じてフィールドに入力します。
開発者ポータル API エンドポイントに関する考慮事項
3scale 2.14 から入手できる開発者ポータル API は、以前のバージョンと互換性がありません。また、3scale 2.14 以降、JSON はすべてのリクエストとレスポンスと互換性のある唯一のデータ形式です。
エンドポイントごとに、次のアクションを実行できます。
-
GET: リソースを読み取り、一覧表示する。 -
POST: リソースを作成および追加する。 -
PUT: リソースを変更する。 -
DELETE: リソースを削除する。
注記
-
組み込みオブジェクトは削除できません。
type=builtin_pageパラメーターを指定してGET /admin/api/cms/templatesエンドポイントを呼び出し、組み込みページのリストとtype=builtin_partialパラメーターを取得して組み込みのパーシャルのリストを取得します。 - 完全バックアップを作成するには、各コンテンツを呼び出す必要があります。すべてのファイルを含む完全なアーカイブをダウンロードする API エンドポイントはありません。
-
contentが送信されないと、公開済みまたはドラフトのコンテンツは返されません。代わりに、コンテンツが長すぎるため、テンプレート名とセクションなどの情報を含むサマリーを返します。
各エンドポイントの下にリストされている詳細を使用して、実行後の出力を調整します。リストされたパラメーターについては、次の点を考慮してください。
- すべてのエンドポイントは、サポートされていないパラメーターを拒否します。サポートされていないパラメーターが送信された場合、リクエストはキャンセルされます。
-
GET /admin/api/cms/templatesエンドポイントでは、contentパラメーターを使用できます。デフォルトでは、開発者ポータルのテンプレートのリストを返します。公開コンテンツおよびドラフトコンテンツも取得するには、content=trueパラメーターを使用します。 -
GET /admin/api/cms/templatesエンドポイントは、結果をフィルタリングするtypeとsection_idパラメーターを使用できます。 -
GET /admin/api/cms/sectionsエンドポイントは、結果を絞り込むparent_idパラメーターを使用できます。 -
GET /admin/api/cms/filesエンドポイントは、結果を絞り込むsection_idパラメーターを使用できます。
