在 AWS AppSync 主控台中啟動結構描述 - AWS AppSync

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

在 AWS AppSync 主控台中啟動結構描述

在此範例中,您將建立 TodoAPI,允許使用者建立日常家務提醒Todo項目,例如 Finish taskPick up groceries。 這API將示範如何使用 DynamoDB 資料表中狀態持續存在的 GraphQL 操作。

概念上,建立第一個 GraphQL 有三個主要步驟API。您必須定義結構描述 (類型和欄位),將資料來源連接至 欄位,然後寫入處理業務邏輯的解析器 (Resolator)。不過,主控台體驗會變更此項目的順序。首先,我們將定義希望資料來源與結構描述互動的方式,稍後再定義結構描述和解析程式。

若要建立 GraphQL API
  1. 登入 AWS Management Console 並開啟AppSync 主控台

  2. 儀表板 中,選擇建立 API

  3. 選取 GraphQL APIs 時,從頭選擇設計 。然後選擇下一步

  4. 對於API名稱 ,將預先填入的名稱變更為 Todo API,然後選擇下一個

    注意

    這裡也有其他選項,但我們不會在此範例中使用這些選項。

  5. 指定 GraphQL 資源區段中,執行下列動作:

    1. 選擇 DynamoDB 資料表支援的建立類型

      注意

      這表示我們將建立新的 DynamoDB 資料表,以作為資料來源連接。

    2. 模型名稱欄位中,輸入 Todo

      注意

      我們的第一個要求是定義我們的結構描述。此模型名稱將是類型名稱,因此您真正要做的是建立 type 名為 的 Todo,該名稱將存在於結構描述中:

      type Todo {}
    3. 欄位 下,執行下列動作:

      1. 建立名為 的欄位id,類型為 ID,所需設定為 Yes

        注意

        這些欄位將存在於您Todo類型的範圍內。此處的欄位名稱將id呼叫為 類型ID!

        type Todo { id: ID! }

        AWS AppSync 支援不同使用案例的多個純量值。

      2. 使用新增欄位 ,建立四個其他欄位,並將Name值設定為 namewherewhendescription。其Type值將為 String,且 ArrayRequired值都會設定為 No。其會如下所示:

        Model information form showing fields for a Todo model with ID, name, when, where, and description.
        注意

        完整類型及其欄位如下所示:

        type Todo { id: ID! name: String when: String where: String description: String }

        因為我們正使用此預先定義的模型建立結構描述,因此它也會根據 createdelete和 等類型填入數個樣板突變update,以協助您輕鬆填入資料來源。

    4. 設定模型資料表 下,輸入資料表名稱,例如 TodoAPITable。將主金鑰設定為 id

      注意

      我們基本上正在建立新的 DynamoDB 資料表,稱為 TodoAPITable 將連接至 API作為我們的主要資料來源。我們的主金鑰會設定為我們在此之前定義的必要id欄位。請注意,此新資料表為空白,不包含除分割區金鑰以外的任何項目。

    5. 選擇 Next (下一步)

  6. 檢閱您的變更,然後選擇建立 API。等待一段時間, AWS AppSync讓服務完成建立您的 API。

您已成功API使用 GraphQL 的結構描述和 DynamoDB 資料來源建立 GraphQL。為了總結上述步驟,我們選擇建立全新的 GraphQL API。我們定義了 的名稱API,然後透過新增我們的第一個類型來新增我們的結構描述定義。我們定義了類型及其欄位,然後選擇透過建立新的 DynamoDB 資料表來將資料來源連接至其中一個欄位,其中沒有資料。