README.md

@bahmutov/cy-api

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:

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'

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

Configuration

var env	default value	description
CYPRESS_API_MESSAGES	true	Show and make call to api server logs
CYPRESS_API_SHOW_CREDENTIALS	false	Show authentication password

By default cy.api print response in the browser. To have the same behaviour as cy.request and use cy.visit normally, you need to desactivate apiDisplayRequest :

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

TypeScript

If your using TypeScript with Cypress, you can add type in your tsconfig.json

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

Examples

• bahmutov/server-logs-example

More info

• Read Black box API testing with server logs
• Read Capture all the logs and @bahmutov/all-logs module.
• Read You Should Test More Using APIs

Small print

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

• @bahmutov
• glebbahmutov.com
• blog

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 <[email protected]>

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.