Request

Request API cung cấp các phương thức để truy cập và thao tác với các yêu cầu HTTP đến trong ứng dụng của bạn. Bạn có thể sử dụng API này để lấy thông tin về yêu cầu, như header, params, và data gửi kèm.

API

Example request

curl --location 'http://localhost:3000/api/register?rol=admin' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Nguyen",
    "lastName": "Nguyen",
    "age": 24
}'

1. all()

Trả về tất cả dữ liệu yêu cầu (bao gồm cả query string và body).

const requestData = request.all();
// requestData = { role: 'admin', firstName: 'Nguyen', lastName: 'Nguyen', age: 24 }

2. query()

Lấy tất cả các tham số trong query string của yêu cầu.

const queryParams = request.query();
// queryParams = { role: 'admin' }

3. input(key: string | string[])

Lấy giá trị của một trường cụ thể từ dữ liệu yêu cầu.

const firstName = request.input('firstName');
// firstName = 'Nguyen'

const selectedData = request.input(['firstName', 'age']);
// selectedData = { firstName: 'Nguyen', age: 24 }

4. only(keys: string[])

Trả về một phần dữ liệu yêu cầu dựa trên các trường được chỉ định.

const requestData = request.only(['firstName', 'lastName']);
// requestData = { firstName: 'Nguyen', lastName: 'Nguyen' }

5. except(keys: string[])

Trả về tất cả dữ liệu của request ngoại trừ các trường được chỉ định.

const requestData = request.except(['age']);
// requestData = { role: 'admin', firstName: 'Nguyen', lastName: 'Nguyen' }

6. headers()

Trả về tất cả các header của request.

const headers = request.headers();
// headers = { 'content-type': 'application/json', ... }

7. header(key: string, defaultValue?: string)

Lấy giá trị của một header cụ thể từ yêu cầu.

const contentType = request.header('Content-Type');
// contentType = 'application/json'

const nonExistentHeader = request.header('Non-Existent', 'default-value');
// nonExistentHeader = 'default-value'

8. param(key: string)

Lấy giá trị của một tham số cụ thể từ query string.

const role = request.param('rol');
// role = 'admin'

9. has(key: string | string[])

Kiểm tra xem một hoặc nhiều trường có tồn tại trong dữ liệu yêu cầu hay không.

const hasRole = request.has('role');
// hasRole = true

const hasNonExistentField = request.has('nonExistentField');
// hasNonExistentField = false

const hasMultipleFields = request.has(['firstName', 'age']);
// hasMultipleFields = true

const hasSomeFields = request.has(['firstName', 'nonExistentField']);
// hasSomeFields = false

10. hasAny(key: string | string[])

Kiểm tra xem ít nhất một trong các trường có tồn tại trong dữ liệu yêu cầu hay không.

const hasAnyRole = request.hasAny(['role', 'nonExistentField']);
// hasAnyRole = true
const hasAnyNonExistent = request.hasAny(['nonExistentField1', 'nonExistentField2']);
// hasAnyNonExistent = false

11. protocol()

Lấy giao thức của request (HTTP hoặc HTTPS).

const protocol = request.protocol();
// protocol = 'http://'

12. hasHeader(key: string)

Kiểm tra xem một header cụ thể có tồn tại trong yêu cầu hay không.

const hasContentType = request.hasHeader('Content-Type');
// hasContentType = true

const hasNonExistentHeader = request.hasHeader('Non-Existent-Header');
// hasNonExistentHeader = false

13. isMethod(method: string)

Kiểm tra xem phương thức của yêu cầu có khớp với phương thức đã cho hay không.

const isPost = request.isMethod('POST');
// isPost = true

const isGet = request.isMethod('GET');
// isGet = false

14. path()

Lấy đường dẫn của request.

const path = request.path();
// path = '/api/register'

15. url()

Lấy URL đầy đủ của request.

const fullUrl = request.url();
// fullUrl = 'http://localhost:3000/api/register'

16. method()

Lấy phương thức HTTP của request.

const method = request.method();
// method = 'POST'

17. validated()

Lấy dữ liệu đã được xác thực từ yêu cầu.

const validatedData = request.validated();
// validatedData = { firstName: 'Nguyen', lastName: 'Nguyen', age: 24 }