Apakah amalan terbaik untuk reka bentuk skema GraphQL?

Question

IT Interview Practice · Accepted Answer

Skema yang baik adalah **dipacu-klien, nullable-secara-lalai pada pinggirnya, dan boleh berkembang tanpa versi**. Ia memodelkan domain dalam istilah yang benar-benar digunakan klien, bukan jadual pangkalan data anda.

## Nullability

Jadikan sesuatu medan non-null (`!`) hanya apabila anda *sentiasa* boleh memulangkannya. Menggunakan `!` secara berlebihan ialah satu perangkap: jika medan non-null ralat, ia menjadikan seluruh object induknya `null`, mengubah kegagalan kecil menjadi ruang kosong yang besar. Utamakan nullable untuk apa-apa yang bergantung kepada perkhidmatan hiliran.

```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
}
```

## Penamaan & input

- Gunakan nama yang konsisten dan deskriptif; boolean dibaca sebagai predikat (`isPublished`).
- Beri setiap mutation satu jenis **`input`** dan pulangkan satu jenis **payload** — anda boleh menambah medan kemudian tanpa memecahkan tandatangan.

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

## Evolusi tanpa pemversian

GraphQL mengelakkan URL `/v2`. Anda berkembang secara **tambahan (additive)**: tambah medan dengan bebas, dan bersarakan medan lama dengan `@deprecated` sementara klien berhijrah.

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

Membuang atau menamakan semula medan ialah satu-satunya perubahan pemecah yang sebenar, jadi reka bentuk supaya anda jarang memerlukannya. Elakkan juga membocorkan bentuk DB (dedahkan `fullName`, bukan `first_name`/`last_name` jika klien mahukan satu medan).

## Mengapa ia penting

Pilihan-pilihan ini yang membezakan skema yang bertahan bertahun-tahun daripada skema yang klien terpaksa berlawan dengannya. Penemu duga menggunakan ini untuk menilai **kematangan reka bentuk API** — terutamanya pertukaran nullability/ralat dan minda evolusi tambahan, yang unik kepada GraphQL.

Nullability

Penamaan & input

Evolusi tanpa pemversian

Mengapa ia penting

Soalan berkaitan