Series: TypeScript Basics Lesson 86

API response types

TypeScript'da API javob type'lari: umumiy ApiResponse<T> qobig'i, muvaffaqiyat va xatoni discriminated union bilan ajratish, pagination, joylashgan generic'lar va internet-do'kon misoli.

86-dars

API response types

Ko'pchilik backend'lar javobni bir xil "qobiq" ichida qaytaradi: data, message, meta va h.k. Shu qobiqni bir marta generic type qilib yozasiz, keyin har bir endpoint uchun faqat ichidagi data'ni almashtirasiz. (Bu darsda 85-darsdagi fetchJson<T> helper'idan foydalanamiz.)

Backend odatda shunday qaytaradi:

{
  "success": true,
  "data": { "id": 1, "name": "Ali" },
  "message": "OK"
}

1. Umumiy qobiq type'i

type ApiResponse<T> = {
  success: boolean;
  data: T;
  message: string;
};

Ishlatish:

type User = { id: number; name: string };

const res = await fetchJson<ApiResponse<User>>("/api/user/1");
res.data.name; // ✅ string

const list = await fetchJson<ApiResponse<User[]>>("/api/users");
list.data.length; // ✅

2. Muvaffaqiyat va xatoni ajratish (eng to'g'ri usul)

Muammo: yuqoridagi type'da xato bo'lsa ham data bor deb hisoblanadi. Yaxshiroq usul: discriminated union (45-dars).

type ApiSuccess<T> = { success: true; data: T };
type ApiError = { success: false; error: { code: string; message: string } };

type ApiResponse<T> = ApiSuccess<T> | ApiError;

const res = await fetchJson<ApiResponse<User>>("/api/user/1");

if (res.success) {
  res.data.name;     // ✅ faqat shu yerda data bor
} else {
  res.error.message; // ✅ faqat shu yerda error bor
}

res.data;
// ❌ Property 'data' does not exist on type 'ApiResponse<User>'.
//    Property 'data' does not exist on type 'ApiError'.

success: true / false — discriminant, TS'ga qaysi variant ekanini aniqlashga yordam beradi.

3. Pagination

type Paginated<T> = {
  items: T[];
  page: number;
  pageSize: number;
  total: number;
};

const res = await fetchJson<ApiResponse<Paginated<Product>>>("/api/products?page=2");

if (res.success) {
  const { items, total } = res.data;
  console.log(`${items.length} / ${total}`);
}

Generic'lar bir-biriga joylashib ketadi: ApiResponse<Paginated<Product>>.

Real misol: internet-do'kon

type Product = {
  id: number;
  title: string;
  price: number;
  discount: number | null; // chegirma bo'lmasligi mumkin
  image?: string;          // maydon umuman kelmasligi mumkin
  createdAt: string;       // JSON'da sana doim string bo'lib keladi
};

async function getProducts(page: number) {
  const res = await fetchJson<ApiResponse<Paginated<Product>>>(
    `/api/products?page=${page}`
  );

  if (!res.success) {
    throw new Error(res.error.message);
  }

  return res.data; // tip: Paginated<Product>
}

discount: number | null va image?: string farqiga e'tibor bering: null — "maydon bor, lekin qiymat yo'q", ? — "maydon umuman kelmasligi mumkin". Backend qaysi birini qaytarishiga qarab to'g'ri yozing.

Eslab qolish uchun

  • Qobiqni bir marta yozing: ApiResponse<T>.
  • Muvaffaqiyat/xatoni union bilan ajrating, if (res.success) bilan tekshiring.
  • null (qiymat yo'q) va ? (maydon yo'q) farqini backend'ga qarab to'g'ri yozing.
  • Sana JSON'da string, Date emas.