如何在AWS Amplify CLI执行amplify push时为schema.graphql添加描述注释

本地Schema注释写法 #

在本地Amplify项目的GraphQL Schema文件中，直接在类型或字段上方用#添加单行注释即可，Amplify CLI会在执行amplify push时自动将这些注释同步到云端AppSync：

# Todo - 我的自定义类型注释
type Todo @model {
  id: ID!
  # 任务的唯一标识ID
  name: String!
  # 任务的详细描述内容
  description: String
}

执行Amplify Push后的效果 #

执行amplify push完成部署后，云端AppSync的Schema会自动带上这些注释。当生成Introspection Schema JSON时，对应的description字段会填充你写的注释内容，示例如下：

{
  "kind": "OBJECT",
  "name": "Todo",
  "description": "Todo - 我的自定义类型注释",
  "fields": [
    {
      "name": "id",
      "description": "任务的唯一标识ID",
      "args": [],
      "type": {
        "kind": "NON_NULL",
        "name": null,
        "ofType": {
          "kind": "SCALAR",
          "name": "ID",
          "ofType": null
        }
      }
    },
    {
      "name": "name",
      "description": "任务的详细描述内容",
      "args": [],
      "type": {
        "kind": "NON_NULL",
        "name": null,
        "ofType": {
          "kind": "SCALAR",
          "name": "String",
          "ofType": null
        }
      }
    }
  ]
}

注意事项 #

• 确保你的Amplify CLI是最新版本（建议v4.50.0及以上），可以通过amplify --version查看版本，版本过低时执行npm install -g @aws-amplify/cli更新
• 仅支持单行#开头的注释，多行注释无法同步到云端
• 如果之前手动修改过云端AppSync的Schema，执行amplify push会用本地Schema覆盖云端，需确保本地注释是最新的

内容的提问来源于stack exchange，提问作者Leonardo Soares Bezerra