cy api

@Bahmutov/Cy-Api

Cypress Custom Command "Cy.API" для тестирования API-API

Эта команда делает HTTP -запросы на внешние серверы, а затем отображает вход и вывод, где веб -приложение обычно находится в тесте Cypress. Если есть журналы на стороне сервера с использованием @bahmutov/all-logs, эта команда приносит их и рендерирует. Вот типичный выход:

Установить

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

или

 yarn add -D @bahmutov/cy-api

Добавьте следующую строку в свой файл поддержки Cypress

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

Это добавит новую команду cy.api для выполнения запросов API.

Конфигурация

var env	значение по умолчанию	описание
Cypress_api_messages	истинный	Показать и сделать вызов в журналы API -сервера
Cypress_api_show_credentials	ЛОЖЬ	Показать пароль аутентификации

По умолчанию ответ печати cy.api в браузере. Чтобы иметь то же поведение, что и cy.request и использовать cy.visit , вам необходимо desactivate apiDisplayRequest :

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

Машинопись

Если вы используете TypeScript с Cypress, вы можете добавить тип в свой tsconfig.json

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

Примеры

• Bahmutov/Server-Logs-Example

Курсы

• ? Плагины Cypress
  • Урок F2: Напишите тест API, используя команду cy.api

Больше информации

• Читать тестирование API Black Box с помощью журналов сервера
• Прочитайте захват все журналы и модуль @bahmutov/all-logs.
• Читайте, вы должны проверить больше, используя API
• Читать использование Cypress для тестирования API

Мелкий шрифт

Автор: Gleb Bahmutov <[email protected]> © 2019

• @bahmutov
• glebbahmutov.com
• блог

Лицензия: MIT - делайте что -нибудь с кодом, но не вините меня, если она не работает.

Поддержка: если вы найдете какие -либо проблемы с этим модулем, электронная почта / твит / открытая проблема на GitHub

MIT Лицензия

Copyright (c) 2019 Gleb Bahmutov <[email protected]>

Настоящее разрешение предоставляется бесплатно любому лицу, получающему копию этого программного обеспечения и связанные с ними файлы документации («Программное обеспечение»), для работы в программном обеспечении без ограничений, включая, помимо прочего, права на использование, копирование, изменение, объединение , публиковать, распространять, сублиценс и/или продавать копии программного обеспечения и разрешить лицам, которым предоставлено программное обеспечение, при условии следующих условий:

Вышеуказанное уведомление об авторском праве и это уведомление о разрешении должно быть включено во все копии или существенные части программного обеспечения.

Программное обеспечение предоставляется «как есть», без гарантии любого рода, явного или подразумеваемого, включая, помимо прочего, гарантии товарной пригодности, пригодности для определенной цели и несоответствия. Ни в коем случае не будут нести ответственность авторов или владельцев авторских прав за любые претензии, ущерб или другую ответственность, будь то в действии контракта, деликте или иным образом, возникающим из или в связи с программным обеспечением или использования или других сделок в ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ.