https://playwright.dev/docs/api/class-apirequest

APIRequest

• APIRequest là một object cung cấp API có thể được sử dụng cho Web API testing. Có thể sử dụng object này để tạo ra instance APIRequestContext

Methods

newContext

• Tạo các instance của APIRequestContext

Cách dùng

await apiRequest.newContext();
await apiRequest.newContext(options);

Các tham số

• options: Object (optional)
  • baseURL : string (optional).
    • Các method như apiRequestContext.get() sẽ sử dụng base URL này khi xây dựng URL tương ứng. Ví dụ:
      • baseURL: http://localhost:3000 và sending request đến /bar.html sẽ dẫn đến http://localhost:3000/bar.html.
      • baseURL: http://localhost:3000/foo/ và sending request đến ./bar.html sẽ dẫn đến http://localhost:3000/foo/bar.html.
      • baseURL: http://localhost:3000/foo (không có dấu gạch chéo ở cuối) và điều hướng đến ./bar.html sẽ dẫn đến http://localhost:3000/bar.html.
  • clientCertificates: Array<Object> (optional)
    • origin: string
    • certPath: string (optional)
      • Đường dẫn đến file chứa certificate ở định dạng PEM.
    • cert: Buffer (optional)
      • Giá trị trực tiếp của certificate ở định dạng PEM.
    • keyPath: string (optional)
      • Đường dẫn đến file chứa private key ở định dạng PEM.
    • key: Buffer (optional)
      • Giá trị trực tiếp của private key ở định dạng PEM.
    • pfxPath: string (optional)
      • Đường dẫn đến file PFX hoặc PKCS12 chứa private key và certificate chain.
    • pfx: Buffer (optional)
      • Giá trị trực tiếp của file PFX hoặc PKCS12 chứa private key và certificate chain.
    • passphrase string (optional)
      • Cụm mật khẩu cho private key (PEM hoặc PFX).
  • TLS Client Authentication cho phép server request client certificate và verify nó. Details
    • Mảng chứa các client certificate sẽ được sử dụng. Mỗi certificate object phải có cả certPath và keyPath, hoặc single pfxPath, hoặc các giá trị trực tiếp tương ứng (cert và key, hoặc pfx). Tùy chọn, passphrase property nên được cung cấp nếu certificate được mã hóa. Thuộc tính origin nên được cung cấp với khớp chính xác với nguồn yêu cầu mà certificate hợp lệ
    • Note: Sử dụng Client Certificates kết hợp với Proxy Servers không được hỗ trợ.
    • Note: Khi sử dụng WebKit trên macOS, truy cập localhost sẽ không nhận Client Certificates. Bạn có thể khắc phục bằng cách thay thế localhost bằng local.playwright.
  • extraHTTPHeaders Object<string, string> (optional)
    • Một object chứa các HTTP headers bổ sung sẽ được gửi với mỗi request. Mặc định là không có.
    • Dùng khi bạn muốn send thêm header cho tất cả các http request.
  • httpCredentials Object (optional): Credentials for HTTP authentication. Nếu không chỉ định nguồn gốc, username và password sẽ được gửi đến bất kỳ server nào khi có unauthorized responses.
    • username string
    • password string
    • origin string (optional)
      • Hạn chế gửi http credentials trên nguồn cụ thể (scheme://host:port).
    • send “unauthorized” | “always” (optional)
      • Option này chỉ áp dụng cho requests sent từ APIRequestContext tương ứng và không ảnh hưởng đến các request được gửi từ trình duyệt.
      • ‘always’ – Tiêu đề Authorization với authentication credentials sẽ được gửi với mỗi API Request.
      • ‘unauthorized’ – Certificate chỉ được gửi khi response 401 (Unauthorized) với tiêu đề WWW-Authenticate được nhận. Mặc định là ‘unauthorized’.
    • ignoreHTTPSErrors boolean (optional): Cho phép bỏ qua HTTPS errors khi sending network requests. Mặc định là false.
    • proxy Object (optional)
      • server string
      • Proxy được sử dụng cho tất cả requests. HTTP và SOCKS được hỗ trợ, ví dụ http://myproxy.com:3128 hoặc socks5://myproxy.com:3128. Dạng rút gọn myproxy.com:3128 được coi là proxy HTTP.
      • bypass string (optional)
      • Các domain được phân tách bằng dấu phẩy để bỏ qua proxy, ví dụ “.com, chromium.org, .domain.com”.
      • username string (optional)
      • Tên người dùng được sử dụng nếu proxy HTTP yêu cầu xác thực.
      • password (tùy chọn): Mật khẩu được sử dụng nếu proxy HTTP yêu cầu xác thực.
    • storageState string | Object (optional): sử dụng lại 1 state đã có. Thường dùng cho việc load các trạng thái đăng nhập đã tồn tại trước đó.
      • cookies Array<Object>
        • name string
        • value string
        • domain string
        • path string
        • expires number
        • Unix time tính bằng giây.
        • httpOnly boolean
        • secure boolean
        • sameSite “Strict” | “Lax” | “None”
      • origins Array<Object>
        • origin string
        • localStorage Array<Object>
        • name string
        • value string
    • timeout number (optional): Thời gian tối đa (mili giây) để chờ response. Mặc định là 30000 (30 giây). Đặt thành 0 để vô hiệu hóa thời gian chờ.
    • userAgent string (optional): User agent cụ thể được sử dụng trong ngữ cảnh này.

Returns

• Hàm này sẽ trả về Promise<APIRequestContext>