npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bahmutov/cy-api

v2.2.8

Published

Custom command cy.api

Downloads

66,363

Readme

@bahmutov/cy-api

renovate-app badge cypress version

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'

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

Courses

More info

Development

  • install all dependencies using npm install
  • start watching and compiling the TS source using npm run build:watch
  • from another terminal launch the local server and open Cypress using npm run dev
  • open the desired Cypress spec file

Small print

Author: Gleb Bahmutov <[email protected]> © 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 <[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.