Schemasprache

Dies ist Teil 4 der Reihe für GraphQL und Adobe Commerce. Die verwendeten Abfragen und Mutationen basieren auf einem bestimmten Datendiagramm, das auf dem Server implementiert wird, den die GraphQL-Laufzeitumgebung zur Auflösung der Abfrage nutzt. Die GraphQL-Spezifikation definiert eine agnostische Sprache zum Ausdrücken der Typen und Beziehungen Ihres Datendiagramms.

Verwandte Videos und Tutorials zu GraphQL in dieser Reihe

Beispielschema

Im Folgenden finden Sie ein abgekürztes Typschema, das die Abfragen und Mutationen unterstützt, die Sie bisher betrachtet haben:

input FilterMatchTypeInput {
  match: String
}

type Money {
  value: Float
}

type Country {
  id: String
  full_name_english: String
}

interface ProductInterface {
  sku: String
  name: String
  related_products: [ProductInterface]
}

type CategoryFilterInput {
  name: FilterMatchTypeInput
}

type CategoryProducts {
  items: [ProductInterface]
}

type CategoryTree {
  name: String
  products(pageSize: Int, currentPage: Int): CategoryProducts
}

type CategoryResult {
  items: [CategoryTree]
}

type Products {
  items: [ProductInterface]
}

type Query {
  country (id: String): Country
  categories (filters: CategoryFilterInput): CategoryResult
  products (search: String): Products
}

input CartItemInput {
  sku: String!
  quantity: Float!
}

type CartPrices {
  grand_total: Money
}

type Cart {
  prices: CartPrices
  total_quantity: Float!
}

type AddProductsToCartOutput {
  cart: Cart!
}

type Mutation {
  addProductsToCart(cartId: String!, cartItems: [CartItemInput!]!): AddProductsToCartOutput
}

Sie können sich die GraphQL-Dokumentation ansehen, um mehr über die Details des Typsystems zu erfahren, einschließlich der Syntax für einige Konzepte, die hier nicht dargestellt werden. Das obige Beispiel ist jedoch selbsterklärend. (Beachten Sie außerdem, wie ähnlich die Syntax der Abfragesyntax ist.) Die Definition eines GraphQL-Schemas dient lediglich dazu, die verfügbaren Argumente und Felder eines bestimmten Typs sowie die Typen dieser Felder auszudrücken. Jeder komplexe Feldtyp muss selbst über eine Definition usw. verfügen, bis Sie zu einfachen Skalartypen wie String gelangen.

Die input -Deklaration ist in jeder Hinsicht wie ein type, definiert jedoch einen Typ, der als Eingabe für ein Argument verwendet werden kann. Beachten Sie auch die Deklaration interface . Dies dient mehr oder weniger der gleichen Funktion wie Schnittstellen in PHP. Andere Typen erben von dieser Schnittstelle.

Die Syntax [CartItemInput!]! sieht schwierig aus, ist aber am Ende ziemlich intuitiv. Die Klammer "! inside"deklariert, dass jeder Wert im Array nicht null sein muss, während die Klammer "outside"angibt, dass der Array-Wert selbst nicht null sein muss (z. B. ein leeres Array).

Nützliche GraphQL-Ressourcen