GraphQL - 引数とエイリアス

はじめに

GraphQLのドキュメントを読んでまとめていきます。

ところどころ気になった部分を調べて補足したり解釈を入れています。

GraphQLは、オブジェクトとそのフィールドを探索するだけでなく、フィールドに引数を渡すことも可能です。

{
  animal(id: "A123") {
    species
    weight
  }
}

{
  "data": {
    "animal": {
      "species": "Tiger",
      "weight": 220.5
    }
  }
}

RESTのようなシステムでは、一連の引数のみを渡すことができますが、GraphQLでは、各フィールドやネストされたオブジェクトに独自の引数セットを渡すことができます。

{
  animal(id: "A123") {
    species
    weight(unit: KILOGRAM)
  }
}

{
  "data": {
    "animal": {
      "species": "Tiger",
      "weight": 220.5
    }
  }
}

結果オブジェクトのフィールドはクエリのフィールド名と一致しますが、引数は含まれません。

そのため、異なる引数で同じフィールドを直接クエリすることはできません。これがエイリアスが必要となる理由です。

{
  savannahAnimal: creature(type: SAVANNAH) {
    species
  }
  jungleAnimal: creature(type: JUNGLE) {
    species
  }
}

{
  "data": {
    "savannahAnimal": {
      "species": "Lion"
    },
    "jungleAnimal": {
      "species": "Jaguar"
    }
  }
}

本記事の内容は以上になります！