cy api

@bahmutov/cy-api

柏树自定义命令“ cy.api”用于端到端API测试

此命令向外部服务器提出HTTP请求，然后渲染Web应用程序通常在柏树测试跑者中的输入和输出。如果使用 @bahmutov/all-logs有服务器端日志，则此命令也将其获取并渲染。这是典型的输出：

安装

 npm install --save-dev @bahmutov/cy-api

或者

 yarn add -D @bahmutov/cy-api

将以下行添加到您的柏树支持文件中

 // usually cypress/support/index.js
import '@bahmutov/cy-api'

这将添加一个用于提出API请求的新命令cy.api 。

配置

var env	默认值	描述
cypress_api_messages	真的	显示并致电API服务器日志
cypress_api_show_credentials	错误的	显示身份验证密码

默认情况下，浏览器中的cy.api打印响应。要apiDisplayRequest与cy.request cy.visit行为相同的行为。

 it ( 'my test without displaying request' , { apiDisplayRequest : false } , ( ) => {
  cy . api ( {
    url : '/' ,
  } )
} ) 

打字稿

如果您与Cypress一起使用打字稿，则可以在tsconfig.json中添加类型

{
  "compilerOptions" : {
    "types" : [ " cypress " , " @bahmutov/cy-api " ]
  }
}

例子

• bahmutov/server-logs-示例

课程

• ？柏树插件
  • F2课：使用CY.API命令编写API测试

更多信息

• 使用服务器日志阅读黑匣子API测试
• 阅读捕获所有日志和 @bahmutov/all-logs模块。
• 阅读您应该使用API​​进行更多测试
• 阅读使用柏树进行API测试

小打印

作者：gleb bahmutov <[email protected]>©2019

• @bahmutov
• glebbahmutov.com
• 博客

许可证：麻省理工学院 - 对代码做任何事情，但是如果它不起作用，请不要怪我。

支持：如果您发现此模块有任何问题，请在GitHub上发送电子邮件 /推文 /打开问题

麻省理工学院许可证

版权（c）2019 gleb bahmutov <[email protected]>

特此免费授予任何获得此软件副本和相关文档文件（“软件”）的人，以无限制处理该软件，包括无限制，使用，复制，修改，合并的权利，发布，分发，分布和/或出售该软件的副本，并允许提供该软件的人，但要遵守以下条件：

上述版权通知和此许可通知应包含在软件的所有副本或大量部分中。

该软件是“原样”提供的，没有任何形式的明示或暗示保证，包括但不限于适销性，特定目的的适用性和非侵权的保证。在任何情况下，作者或版权持有人均不应对任何索赔，损害赔偿或其他责任责任，无论是在合同，侵权或其他方面的诉讼中，与软件或与软件或使用或其他交易有关的诉讼或其他责任软件。