Mik a GraphQL séma tervezésének legjobb gyakorlatai?

Question

IT Interview Practice · Accepted Answer

Egy jó séma **kliens-vezérelt, a széleken alapból nullable, és verziók nélkül fejleszthető**. A domaint azokban a fogalmakban modellezi, amelyeket a kliensek ténylegesen használnak, nem az adatbázistábláid szerint.

## Nullability

Egy mezőt csak akkor tegyél non-null-lá (`!`), ha *mindig* vissza tudod adni. A `!` túlzott használata csapda: ha egy non-null mező hibázik, az az egész parent objectet nullázza, egy kis hibából nagy üres foltot csinálva. Bármihez, ami egy downstream szolgáltatástól függ, inkább nullable-t válassz.

```graphql
type User {
  id: ID!             # truly always present
  email: String!      # required in your DB -> safe as non-null
  avatarUrl: String   # comes from an external service -> nullable, so its failure is isolated
}
```

## Elnevezés és inputok

- Használj következetes, beszédes neveket; a boolean értékek állításként olvasandók (`isPublished`).
- Adj minden mutationnek egyetlen **`input`** típust, és adj vissza egy **payload** típust — később úgy adhatsz hozzá mezőket, hogy nem töröd el a szignatúrát.

```graphql
input CreatePostInput { title: String!, body: String! }
type CreatePostPayload { post: Post!, errors: [UserError!]! }  # room to grow
type Mutation { createPost(input: CreatePostInput!): CreatePostPayload! }
```

## Fejlesztés verziózás nélkül

A GraphQL elkerüli a `/v2` URL-eket. **Additív** módon fejlesztesz: mezőket szabadon adsz hozzá, a régieket pedig `@deprecated`-del vezeted ki, miközben a kliensek átállnak.

```graphql
type User {
  fullName: String!
  name: String! @deprecated(reason: "Use fullName")   # keep serving until clients move off
}
```

Egy mező eltávolítása vagy átnevezése az egyetlen valódi breaking change, ezért úgy tervezz, hogy erre ritkán legyen szükség. Kerüld a DB-struktúra kiszivárogtatását is (`fullName`-et tegyél elérhetővé, ne `first_name`/`last_name`-et, ha a kliensek egyetlen mezőt szeretnének).

## Miért fontos

Ezek a döntések különböztetik meg az évekig kitartó sémát attól, amellyel a kliensek küzdenek. Az interjúztatók ezzel mérik az **API-tervezési érettséget** — különösen a nullability/hiba kompromisszumot és az additív fejlesztés szemléletét, amelyek egyediek a GraphQL-ben.

Nullability

Elnevezés és inputok

Fejlesztés verziózás nélkül

Miért fontos

Kapcsolódó kérdések