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]>

特此免費授予任何獲得此軟件副本和相關文檔文件（“軟件”）的人，以無限制處理該軟件，包括無限制，使用，複製，修改，合併的權利，發布，分發，分佈和/或出售該軟件的副本，並允許提供該軟件的人，但要遵守以下條件：

上述版權通知和此許可通知應包含在軟件的所有副本或大量部分中。

該軟件是“原樣”提供的，沒有任何形式的明示或暗示保證，包括但不限於適銷性，特定目的的適用性和非侵權的保證。 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE軟體.