Skip to content
Cypress custom command "cy.api" for end-to-end API testing
JavaScript
Branch: master
Clone or download

README.md

@bahmutov/cy-api renovate-app badge CircleCI

Cypress custom command "cy.api" for end-to-end API testing

This command makes HTTP requests to external servers, then renders the input and output where the web application usually is in the Cypress Test Runner. If there are server-side logs using @bahmutov/all-logs, this command fetches them and renders too. Here is typical output:

cy.api in action

Install

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

or

yarn add -D @bahmutov/cy-api

Add the following line to your Cypress support file

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

This will add a new command cy.api for making API requests.

TypeScript

The definition for cy.api command is in index.d.ts file. If you are using JavaScript, include the following line in our spec files

// cypress/integration/my-spec.js
/// <reference types="@bahmutov/cy-api" />

With this line, you should have Intelligent Code Completion working in most IDEs and the TypeScript compiler should understand the cy.api command.

Examples

More info

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2019

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2019 Gleb Bahmutov <gleb.bahmutov@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 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 SOFTWARE.

You can’t perform that action at this time.