request
request là API dùng để thực hiện các network request. Hiện chỉ hỗ trợ những request qua giao thức https.
Ứng dụng của bạn sẽ được chạy trong môi trường cô lập thuần javascript nên sẽ không có các hàm gọi network thông thường như fetch hay XMLHttpRequest. Để thực hiện gọi network bạn phải dùng đến request.
Tham số
Để cấu hình việc gọi network, bạn cần truyền object với các thuộc tính sau:
| Thuộc tính | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|
| url | string | ✓ | Đường dẫn muốn gọi tới. |
| headers | object | Cấu hình headers khi thực hiện gọi network. | |
| method | string | Phương thức gọi network. Mặc định sẽ là GET. | |
| data | object | Data kèm theo trong request. | |
| timeout | number | Request sẽ bị cancel sau khoảng thời gian timeout. Đơn vị là mili giây (ms); mặc định là 30,000 (30s) | |
| dataType | string | Quy định định dạng dữ liệu (data format) trả về sau request. Hỗ trợ JSON, text, base64 và arraybuffer; mặc định là JSON. | |
| includeHeader | boolean | Quy định dữ liệu trả về trường hợp thành công có bao gồm headers hay không. | |
| success | Function | Callback function khi việc gọi network thành công. | |
| fail | Function | Callback function khi việc gọi network thất bại. | |
| complete | Function | Callback function khi việc gọi network kết thúc cho dù thành công hay thất bại. |
Callback success function payload
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
| data | String/Object | Dữ liệu trả về. Định dạng của nó phụ thuộc vào tuộc tính dataType. |
Ví dụ
import apis from '@v-miniapp/apis'
apis.request({
url: 'https://httpbin.org/post',
method: 'POST',
headers: {
Authorization: 'Bearer Token',
},
data: {
data: 'Test Data',
},
success: response => {},
fail: error => {},
})