vREST Documentation Home

Welcome to vREST Documentation Home.

Index

vREST Cookbook
About vREST
About sample test application
Setup / install contacts application
Writing your first test case
Response Validation
Benefits of using Response Validators
JSON Response Validation Scenarios
XML Response Validation Scenarios
Schema Validation
Array Comparison Strategies for Diff report
Environments / Variables
Global Variables / Environments
Extracting variables from API response
Special Variables
Extracting variable via Utility Methods
Extracting variables from test case results
Authentication
Token based authentication
Cookie Based Authentication
Authorization
Basic Authorization
Raw Authorization
OAuth 1.0
OAuth 2.0
Executing test cases
Viewing previous test run results
Chaining Multiple Requests
JSON Path Syntax
XML Path Syntax
Conditional Execution of Test Cases
Continuous Integration
Jenkins Server
Bitbucket Pipelines Integration
TeamCity Integration
Visual Studio Team Services Integration
Looping
Data driven testing
Data Driven Testing via CSV Sample Files
HTTP Recording via Chrome Extension
Extension Configuration
How HTTP Recorder Works
Debugging
Scheduling vREST Test Cases
Scheduling on Windows
Scheduling on Linux/Mac
Setup and Tear Down for Test Cases
Mock Server
Quick Start Guide For Mock Server
How Mock Server works
Setting up Mock Authentication
JSON request body comparisons in Mock Server
XML request body comparisons in Mock Server
Special Methods to be used in Expected Response
Tips on writing maintainable Test Cases
Third party tools integration via Hooks
Configuring Hooks
Data Format of hook variables
Import built-in Templates
Third party tools - JIRA / Slack/TestRail ...
vREST User Guide
Test Cases Tab
Test Cases tab LHS pane
Test Cases tab tool bar
Test Cases tab main body
Mock Server Tab
API Mocks
Mock Logger
Test Runs tab
Test Runs tab tool bar
Test Runs tab main body
Hooks tab
Hooks tab LHS pane
Hooks tab tool bar
Hooks tab main body
Project Configuration tab
Versions
Test Suites
Response Validators
Utility Methods
Tags
Project Users
Instance Configuration
General Configuration
Setup Projects
Setup Users
Roles and Permissions
Migration Guide
vREST data migration from v2.4.5 to v2.5.0
vREST Enterprise
Download Enterprise vREST
Enterprise Trial Subscription
Purchasing Enterprise subscription
Quick Installation
Setting up enterprise licence
Common exceptions during installation and their resolutions
Running vREST Enterprise as service
For Linux via systemd
For Windows
MongoDB x509 authentication settings
Running vREST Enterprise on SSL
vREST supported add-ons
vrunner
Setup / Install vrunner
vREST Utility (vutil)
Setup / Install vutil (Linux/Mac)
Setup / Install vutil (Windows 64 bit)
Database Validation
Execute a system command, bash script via REST API
Fetch CSV data for data driven testing
Read System file via API
Executing multipart requests / Process multipart or complex responses
vREST Import / Export Utility (vrest_ie)
Setup / Install vREST Import/Export Utility
Frequently Asked Questions - FAQs
How can I allow access to Support Team in my project to debug an issue?
How to specify JSON payload or multi level parameters in a test case?
How can I add team members in my vREST project?
How can I validate localhost or intranet hosted web applications in vREST?
Pre-process request body before executing test cases
How can I update the Chrome extension "vREST Chrome Extension" manually?
Extracting variables in a loop
How to perform cookie based authentication?
vREST Subscription
How to increase number of users for vREST subscription?
How do I update billing information for my vREST subscription?
Is there any limit on number of requests for a vREST subscription plan and how we can increase it?
How can I stop vREST subscription's recurring billing?
How can I purchase a new vREST subscription?
How we can use vREST?
How to handle self signed certificates check in vREST while test case execution?

Note

Please feel free to send us your valuable suggestions by dropping us a mail at support@vrest.io.