Skip to Content

useApi

Hook trả một instance axios thô để gọi API bên ngoài app bằng URL tuyệt đối.

Cách dùng

app/components/province-select.tsx
import { Select } from "antd"; import { useApi, useRequest } from "app/hooks"; export function ProvinceSelect(props: { value?: string; onChange?: (v: string) => void }) { const http = useApi(); // hook: gọi ở đầu component const { data, loading } = useRequest(() => http.get("https://provinces.example.vn/api/p/").then((r) => r.data), ); return <Select {...props} loading={loading} options={(data ?? []).map((p: any) => ({ label: p.name, value: p.code }))} />; }

Chữ ký

app/hooks.ts
import type { AxiosInstance } from "axios"; function useApi(): AxiosInstance;

Tham số

Không có.

Trả về

Một instance axios, tạo một lần cho mỗi component. Mỗi request:

  • có baseURL là API của app, nên đường dẫn tương đối như "/orders" đi tới chính app;
  • tự gửi Authorization: Bearer <token> khi đã có token (xem setAuthToken), trừ khi bạn tự đặt header Authorization. Token chỉ gửi tới API của chính app (URL tương đối hoặc cùng origin với API); URL bên ngoài không bao giờ nhận được token.

Instance cũng xử lý lỗi theo cùng một cách cho mọi trang:

  • Lần đọc (GET, HEAD) gặp mất mạng, hoặc lỗi bận có retryable: true (429, 503, 504, xem Mã lỗi), được gọi lại, tổng cộng tối đa 3 lần: đợi đúng retry-after, không có thì lùi dần có ngẫu nhiên. Server bảo đợi quá 8 giây thì không đợi, lỗi tới trang luôn. Lỗi 4xx khác 429 không bao giờ gọi lại.
  • Lần ghi chỉ tự gọi lại khi có header Idempotency-Key (http.post(url, body, { headers: { "Idempotency-Key": key } })), vì không có khoá thì lần đầu có thể đã ghi xong.
  • Lỗi cuối cùng mang e.ftCode (mã lỗi) và e.requestId (mã của request, để tra nhật ký).
  • Request đã đăng nhập mà nhận 401 (phiên hết hạn hoặc tài khoản bị khoá): hook đăng xuất và đưa về /login một lần.
  • App dùng khung AppShell của manh/shell: lỗi khác 401 tự hiện câu báo của server. Truyền { silent: true } trong cấu hình của lần gọi để tắt.

Kết quả là AxiosResponse: dữ liệu nằm ở res.data.

Ví dụ

useApi là hook thật. Gọi nó ở đầu component, giữ instance trong biến, rồi dùng instance đó trong hàm xử lý sự kiện:

app/components/tax-lookup.tsx
const http = useApi(); async function lookup(taxCode: string) { const res = await http.get(`https://api.example.vn/tax/${taxCode}`); return res.data; }
  • Với API của chính app, dùng useApiClient. useApi() kèm đường dẫn "/…" vẫn chạy nhưng không có kiểu, và check cảnh báo code.no-raw-useapi-on-own-backend.

Bước tiếp theo

Cập nhật