Cách đọc tài liệu API
Bạn sẽ sống trong tài liệu , vậy nên đây là cách lấy được thứ bạn cần nhanh chóng mà không cần đọc hết. Với bất kỳ nào, hãy tìm năm thứ:
- Phương thức và —
GET /forecast. Nó làm gì, chỉ trong hai từ. - Xác thực (Authentication) — nó cần header hay khóa nào. Thường là một phần chung cho toàn bộ API.
- Tham số (Parameters) — các đầu vào bạn có thể gửi (ở đây là
city), cái nào là bắt buộc, và kiểu dữ liệu của chúng. - Một ví dụ về phản hồi (response) — hình dạng bạn sẽ nhận lại. Đây là vàng ròng; hãy sao chép nó.
- Lỗi (Errors) — những gì trả về khi có gì đó sai, và các mã trạng thái (
401không được ủy quyền,404không tìm thấy,429bị giới hạn tần suất).
Tài liệu tốt bao gồm một request và response mẫu có thể sao chép-dán được. Hai đoạn mẫu đó cho bạn biết nhiều hơn cả những đoạn văn dài dòng — hãy lấy chúng và đưa cho AI.