cy api

@bahmutov/cy-api

Cypress Custom Command "Cy.api" für End-to-End-API-Tests

In diesem Befehl stellt HTTP -Anforderungen an externe Server an und rendert dann die Eingabe und Ausgabe, wo sich die Webanwendung normalerweise im Cypress -Testläufer befindet. Wenn es serverseitige Protokolle mit @bahmutov/All-Logs gibt, holt dieser Befehl sie ab und rendert auch. Hier ist ein typischer Ausgang:

Installieren

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

oder

 yarn add -D @bahmutov/cy-api

Fügen Sie Ihrer Cypress -Support -Datei die folgende Zeile hinzu

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

Dadurch wird ein neuer Befehl cy.api für API -Anfragen hinzugefügt.

Konfiguration

var en	Standardwert	Beschreibung
Cypress_API_Messages	WAHR	Zeigen und telefonieren Sie bei API -Serverprotokollen
Cypress_API_Show_Credentials	FALSCH	Authentifizierungskennwort anzeigen

Standardmäßig drucken Sie die Antwort cy.api im Browser. Um das gleiche Verhalten wie cy.request zu haben und cy.visit Normalerweise zu verwenden, müssen Sie apiDisplayRequest deaktivieren:

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

Typoskript

Wenn Sie TypeScript mit Cypress verwenden, können Sie Ihren tsconfig.json einen Typ hinzufügen

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

Beispiele

• Bahmutov/Server-Logs-Beispiel

Kurse

• ? Cypress -Plugins
  • Lektion F2: Schreiben Sie einen API -Test mit dem Befehl cy.api

Weitere Informationen

• Lesen Sie Black Box API -Tests mit Serverprotokollen
• Lesen Sie Capture alle Protokolle und @Bahmutov/All-Logs-Modul.
• Lesen Sie, Sie sollten mehr mit APIs testen
• Lesen Sie verwenden Sie Cypress für API -Tests

Kleingedruckte

Autor: Gleb Bahmutov <[email protected]> © 2019

• @bahmutov
• glebbahmutov.com
• Blog

Lizenz: MIT - Mach etwas mit dem Code, aber beschuldige mich nicht, wenn es nicht funktioniert.

Support: Wenn Sie Probleme mit diesem Modul finden, E -Mail / Tweet / Öffnen Sie das Problem auf GitHub

MIT -Lizenz

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

Die Erlaubnis wird hiermit kostenlos an eine Person erteilt, die eine Kopie dieser Software und zugehörigen Dokumentationsdateien ("Software") erhält, um die Software ohne Einschränkung zu behandeln, einschließlich ohne Einschränkung der Rechte zu verwenden, zu kopieren, zu modifizieren, zu verschmelzen, verschmelzen , veröffentlichen, vertreiben, unterlizenzieren und/oder Kopien der Software verkaufen und Personen, denen die Software dazu bereitgestellt wird, unter den folgenden Bedingungen ermöglicht:

Die oben genannte Copyright -Mitteilung und diese Erlaubnisbekanntmachung müssen in alle Kopien oder wesentlichen Teile der Software enthalten sein.

Die Software wird "wie es ist" ohne Garantie jeglicher Art, ausdrücklich oder stillschweigend bereitgestellt, einschließlich, aber nicht beschränkt auf die Gewährleistung der Handelsfähigkeit, die Eignung für einen bestimmten Zweck und die Nichtverletzung. In keinem Fall haftet die Autoren oder Urheberrechtsinhaber für Ansprüche, Schäden oder andere Haftungen, sei es in einer Vertragsklage, unerlaubter Handlung oder anderweitig, aus oder im Zusammenhang mit der Software oder anderen Geschäften in der SOFTWARE.