cy.intercept(url, routeHandler?)
cy.intercept(method, url, routeHandler?)
cy.intercept(routeMatcher, routeHandler?)

cy.intercept('//example.com/widgets')
cy.intercept('//example.com/widgets', { fixture: 'widgets.json' })

cy.intercept('POST', '//example.com/widgets', {
  statusCode: 200,
  body: 'it worked!'
})

{
  /**
   * 與 HTTP Basic身份驗證中使用的用戶名和密碼匹配
   */
  auth?: { username: string | RegExp, password: string | RegExp }

  /**
   * 與請求上的 HTTP Headers 匹配
   */
  headers?: {
    [name: string]: string | RegExp
  }

  /**
   * 與請求上的 hostname 匹配
   */
  hostname?: string | RegExp

  /**
   * If 'true', 只有 https 的請求會被匹配
   * If 'false', 只有 http 的請求會被匹配
   */
  https?: boolean

  /**
   * 與請求上的 method 請求方法匹配
   * 默認 '*', 匹配全部類型的 method
   */
  method?: string | RegExp

  /**
   * 主機名後的路徑, 包括了 ？ 後面的查詢參數
   * www.baidu.com/s?wd=2
   */
  path?: string | RegExp

  /**
   * 和 path 一樣, 不過不管 ? 後面的查詢參數
   * www.baidu.com/s
   */
  pathname?: string | RegExp

  /**
   * 與指定的埠匹配, 或者傳遞多個埠組成的數組, 其中一個匹配上就行了
   */
  port?: number | number[]

  /**
   * 與請求路徑 ? 後面跟的查詢參數匹配上
   * wd=2
   */
  query?: {
    [key: string]: string | RegExp
  }

  /**
   * 完整的請求 url
   * //www.baidu.com/s?wd=2
   */
  url?: string | RegExp
}

{
  /**
   * 將 fixture 文件作為響應主體, 以 cypress/fixtures 為根目錄
   */
  fixture?: string
  /**
   * 將字元串或 JSON 對象作為響應主體
   */
  body?: string | object | object[]
  /**
   * 響應 headers
   * @default {}
   */
  headers?: { [key: string]: string }
  /**
   * 響應狀態碼
   * @default 200
   */
  statusCode?: number
  /**
   * 如果 true, Cypress 將破壞網路連接, 並且不發送任何響應
   * 主要用於模擬無法訪問的伺服器
   * 請勿與其他選項結合使用
   */
  forceNetworkError?: boolean
  /**
   * 發送響應前要延遲的毫秒數
   */
  delayMs?: number
  /**
   * 以多少 kbps 發送響應體
   */
  throttleKbps?: number
}

npm start

// 斷言匹配此路由的請求接收到包含【username】的請求 body
cy.wait('@login3').its('request.body').should('have.property', 'username')

// 斷言匹配此路由的請求接收到 HTTP 狀態碼為 500
cy.wait('@login3').its('response.statusCode').should('eq', 200)

// 斷言匹配此路由的請求接收到包含【redirect】的請求 body
cy.wait('@login3').its('response.body').should('have.property', 'redirect')

beforeEach(() => {
    cy.visit('//localhost:7079/login')
})

{
  /**
   * 銷毀該請求並返回網路錯誤的響應
   */
  destroy(): void

  /**
   * 控制請求的響應
   * 如果傳入的是一個函數, 則它是回調函數, 當響應時會調用
   * 如果傳入的是一個 StaticResponse 對象, 將不會發出請求, 而是直接將這個對象當做響應返回
   */
  reply(interceptor?: StaticResponse | HttpResponseInterceptor): void

  /**
   * 使用 response body(必填) 和 response header(可選) 響應請求
   */
  reply(body: string | object, headers?: { [key: string]: string }): void

  /**
   * 使用 HTTP 狀態碼(必填)、 response body(可選)、response header(可選) 響應請求
   */
  reply(status: number, body?: string | object, headers?: { [key: string]: string }): void

  /**
   * 重定向到新的 location 來響應請求,
   * @param statusCode 用來重定向的 HTTP 狀態程式碼, Default: 302
   */
  redirect(location: string, statusCode?: number): void
}

cy.intercept('/login', (req) => {
    // functions on 'req' can be used to dynamically respond to a request here

    // 將請求發送到目標伺服器
    req.reply()

    // 將這個 JSON 對象響應請求
    req.reply({plan: 'starter'})

    // 將請求發送到目標伺服器, 並且攔截伺服器返回的實際響應, 然後進行後續操作(類似抓包工具對響應打斷點)
    req.reply((res) => {
        // res 就是實際的響應對象
    })
})

cy.intercept('/notification', (req) => {
    req.reply((resp) => {
        // Success 將作為 response body 返回到瀏覽器
        resp.send('Success')

        // 將 success.json 裡面的數據作為 response body 返回到瀏覽器
        resp.send({fixture: 'success.json'})

        // 將響應延遲 1000ms
        resp.delay(1000)

        // 將響應限制為 64kbps
        resp.throttle(64)
    })
})

{
/**
* 可以自定義 response statusCode、response body、response header
* 也可以直接傳 StaticResponse 對象
*/
send(status: number, body?: string | number | object, headers?: { [key: string]: string }): void
send(body: string | object, headers?: { [key: string]: string }): void
send(staticResponse: StaticResponse): void
/**
* 繼續返迴響應
*/
send(): void
/**
* 等待 delayMs 毫秒，然後再將響應發送給客戶端
*/
delay: (delayMs: number) => IncomingHttpResponse
/**
* 以多少 kbps 的速度發送響應
*/
throttle: (throttleKbps: number) => IncomingHttpResponse
}