App Services アプリの作成

アプリ サービス UI に移動する

Atlas UI プロジェクト ダッシュボードで、[ App Servicesタブをクリックします。

アプリの種類の選択

新しい空白のアプリを作成するか、いくつかのサービスが事前構成されたテンプレートから開始することができます。 一部のテンプレート アプリには、対応するクライアント アプリケーションも付属しています。

詳しくは、「テンプレート アプリ 」を参照してください。

プロジェクトにアプリがない場合は、テンプレートから新しいアプリを作成するか、最初から開始するように求められます。

それ以外の場合は、 App Servicesタブの右上にある 2 つの作成ボタンのいずれかを選択できます。

• 空白のアプリを作成するには、[ Create a New App ] ボタンをクリックします。

• テンプレートを使用するには、 Create App from Templateをクリックし、ドロップダウン メニューからテンプレートを選択します。

アプリ設定の構成

UI では、次の設定を構成するように求められます。

• アプリケーション名。 アプリ名は公開され、クライアントが使用するアプリ ID に含まれます。

  注意

  アプリ名の制限

  アプリケーション名は 1 から 32 文字の間で、ASCII 文字、数字、アンダースコア、ハイフンのみを含めることができます。

• リンクされたデータソース。 これは、アプリがアクセスできる Atlas クラスターです。 プロジェクトにクラスターがない場合は、App Services によって自動的にクラスターが作成されます。

  注意

  MongoDB バージョン5.0以上が必要

  Atlas Device Sync には MongoDB バージョン5.0以降を実行している Atlas クラスターが必要です。 クラスターを構成するとき、 Additional Settingsの下のドロップダウン メニューからバージョンを選択します。

Advanced Configurationでは、次のオプション設定を構成することもできます。

• アプリを実行する場所とそのメタデータを保存する場所を決定するアプリケーション リージョン。 詳しくは、「配置モデルとリージョン 」を参照してください。

• 使用する環境値を決定するApp Encryption 環境。 詳しくは、「アプリ環境の構成 」を参照してください。

アプリを作成する

アプリを設定したら、[ Create App Service ] をクリックします。

アプリを作成すると、Atlas UI は App Services Admin UI に自動的にリダイレクトします。

MongoDB Atlas ユーザーの認証

MongoDB Atlas Admin API キーを使用して CLI にログインします。

appservices login --api-key="<my api key>" --private-api-key="<my private api key>"

アプリ作成コマンドの実行

CLI はアプリを作成し、その構成ファイルを 1 回の コマンドでローカル ディレクトリにコピーできます。 コマンドでは、アプリ名と、そのアプリを含める必要がある Atlas プロジェクトを指定するよう求められます。 コマンドは、フラグ付きで、または対話的に構成できます。

appservices apps create

コマンドは、アプリをカスタマイズするために任意で含めることができる追加のフラグもサポートしています。 次の表は、使用できる一般的なフラグを示しています。

Admin API アクセス トークンを取得する

MongoDB Atlas API キー ペアを使用して、管理ユーザー認証エンドポイントを呼び出します。

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "username": "<Public API Key>",
    "apiKey": "<Private API Key>"
  }'

認証に成功すると、レスポンス本文にはaccess_token値を持つ JSON オブジェクトが含まれます。

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

access_tokenは App Services Admin API へのアクセスを許可します。 すべての管理 API リクエストのAuthorizationヘッダーに Bearer トークンとして含める必要があります。

プロジェクトID の取得

すべてのApp Services AppはMongoDB Atlasプロジェクトに属します。

アプリを作成するには、アプリを含む MongoDB Atlas プロジェクトのプロジェクト ID（グループ ID とも呼ばれます）が必要です。 この ID は、API リクエストの URL に含めます。

新しいアプリを作成する

アプリの作成エンドポイントを使用して新しいアプリを作成できます。

リクエストには、以下の内容が必要です。

• Authorization管理 API アクセス トークンが Bearer トークン として含まれる ヘッダー。

• 新しいアプリのname

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps \
  --header 'Authorization:  Bearer <access_token>' \
  --data '{ "name": "<App Name>" }'

テンプレートからアプリを作成する 場合は、リクエスト本文に次の内容も含める必要があります。

• 使用可能なテンプレート アプリの 1 つを含むtemplate_idフィールド。 すべてのテンプレート アプリのリストについては、利用可能なテンプレート アプリ を参照してください。

• 既存の Atlas クラスターに関する情報を含むdata_sourceフィールド。

  curl -X POST \
    https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps \
    -H 'Authorization:  Bearer <access_token>' \
    -d '{
      "name": "<App Name>",
      "template_id": "<Template App Id>",
      "data_source": {
        "name": "mongodb-atlas",
        "type": "mongodb-atlas",
        "config": {
          "clusterName": "<Atlas Cluster Name>"
        }
      }
    }'

アプリが正常に作成されると、API は新しいアプリに関する情報を含む201レスポンスを返します。