Skip to content

Commit

Permalink
Completed some documentation and added images
Browse files Browse the repository at this point in the history
  • Loading branch information
sclavijosuero committed Oct 6, 2024
1 parent b6dfe97 commit 5bbf441
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 5 deletions.
22 changes: 18 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
node_modules/
cypress/screenshots/
cypress/videos/
cypress/downloads/
# Cypress generated files
/cypress/videos/
/cypress/screenshots/
/cypress/downloads/

# Node.js dependencies
/node_modules/

# Doc videos
/videos/

# Editor-specific files
/.vscode/
/.idea/

# Common ignore patterns for Windows and macOS
.DS_Store
Thumbs.db
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ A Cypress plugin for API testing to validate the API response against Plain JSON

![Overview](images/overview.png)

For a detailed guide on how to use this plugin, check out my blog post, ["CYPRESS-AJV-SCHEMA-VALIDATOR Plugin: The Brave Vigilante for Your API Contracts,"](https://dev.to/sebastianclavijo/cypress-ajv-schema-validator-plugin-the-brave-vigilante-for-your-api-contracts-5cfe) on my Cypress blog. There you'll find comprehensive information about setting up and getting the most out of this plugin.
For a detailed guide on setting up and using this plugin to maximize its benefits, please refer to my articles:
- ["CYPRESS-AJV-SCHEMA-VALIDATOR Plugin: The Brave Vigilante for Your API Contracts"](https://dev.to/sebastianclavijo/cypress-ajv-schema-validator-plugin-the-brave-vigilante-for-your-api-contracts-5cfe)
- ["CYPRESS-AJV-SCHEMA-VALIDATOR v1.2.0: Boost Debugging Skills from Vigilante to Superhero with Advanced Schema Error Insights!"](https://dev.to/sebastianclavijo/cypress-ajv-schema-validator-v120-boost-debugging-skills-from-vigilante-to-superhero-with-advanced-schema-error-insights-1hld)


## Main Features

Expand Down Expand Up @@ -249,12 +252,18 @@ When the Cypress environment variable `enableMismatchesOnUI` is set to `true`, a

![Plugin @bahmutov/cy-api](images/cy_api_1.png)

It will follow the the same color legend as in the Cypress Log.

![Plugin @bahmutov/cy-api](images/cy_api_1_details.png)

### cypress-plugin-api Plugin

Similarly, when the Cypress environment variable `enableMismatchesOnUI` is set to `true`, and the `cypress-plugin-api` plugin is imported into your `cypress/support/commands.js` or test file, schema violations will be shown in the plugin's UI.

![Plugin cypress-plugin-api](images/cy_api_2.png)

![Plugin @bahmutov/cy-api](images/cy_api_2_details.png)


## Disable JSON Schema Validation in your Tests

Expand Down Expand Up @@ -282,6 +291,7 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
### [1.2.0]
- Integration with bahmutov/cy-api and filiphric/cypress-plugin-api to show JSON violations directly in their outputs on the UI.
- New Cypress environment variable to disable schema validation.
- Change in the icons to flag schema issues.

### [1.1.1]
- Added details to documentation.
Expand Down
Binary file added images/cy_api_1_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cy_api_2_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5bbf441

Please sign in to comment.