https://github.com/bahmutov/cy-api
Cypress custom command "cy.api" for end-to-end API testing
https://github.com/bahmutov/cy-api
cypress cypress-io cypress-plugin
Last synced: 5 months ago
JSON representation
Cypress custom command "cy.api" for end-to-end API testing
- Host: GitHub
- URL: https://github.com/bahmutov/cy-api
- Owner: bahmutov
- Created: 2019-07-09T01:42:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-28T04:12:27.000Z (9 months ago)
- Last Synced: 2024-10-19T06:16:25.025Z (8 months ago)
- Topics: cypress, cypress-io, cypress-plugin
- Language: TypeScript
- Homepage:
- Size: 923 KB
- Stars: 208
- Watchers: 6
- Forks: 23
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @bahmutov/cy-api
[![renovate-app badge][renovate-badge]][renovate-app] 
> 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][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
```js
// 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` :
```js
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`
```json
{
"compilerOptions": {
"types": ["cypress", "@bahmutov/cy-api"]
}
}
```
## Examples
- [bahmutov/server-logs-example](https://github.com/bahmutov/server-logs-example)
### Courses
- 🎓 [Cypress Plugins](https://cypress.tips/courses/cypress-plugins/)
- [Lesson f2: Write an API test using the cy.api command](https://cypress.tips/courses/cypress-plugins/lessons/f2)
## More info
- Read [Black box API testing with server logs](https://glebbahmutov.com/blog/api-testing-with-server-logs/)
- Read [Capture all the logs](https://glebbahmutov.com/blog/capture-all-the-logs/) and [@bahmutov/all-logs][all-logs] module.
- Read [You Should Test More Using APIs](https://glebbahmutov.com/blog/test-using-apis/)
- Read [Use Cypress For API Testing](https://glebbahmutov.com/blog/use-cypress-for-api-testing/)
[all-logs]: https://github.com/bahmutov/all-logs
## 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
- [@bahmutov](https://twitter.com/bahmutov)
- [glebbahmutov.com](https://glebbahmutov.com)
- [blog](https://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](https://github.com/bahmutov/cy-api/issues) 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.
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/