Quick Start

Setup your first Scenarios and use them

Overview

This section will show how to import a Postman collection, pre-configured with all requests to create Scenarios for a User entity CRUD and requests to use the created Scenarios.

These examples are all based on HTTP protocol, so, to mock the behavior of a specific HTTP endpoint it is necessary to create a Scenario to each behavior (success, bad request, username already taken, etc) and, as all these Scenarios belongs to the same endpoint, they must be grouped under the same ScenarioKey. For the HTTP protocol a ScenarioKey is composed by the fields protocol, pathTemplate and method, example: * protocol: HTTP * pathTemplate: /users * method: POST

So, to use Copycat, we just need to create the desired Scenarios for an endpoint, and it will be immediately available to usage.

Import Postman Collection

First of all, download the Postman collection.

Then, import the collection clicking on the Import button

Import button

Select the downloaded file clicking on Upload Files button

Import button 02

After that the collection will be imported:

Result

Import Postman Environment

After importing the Postman Collection, it is necessary to import the Postman environment, this file contains pre-defined variables to access Copycat.

Warning

Copycat uses a pair of Keys to limit access to Scenarios and stored data, this guide uses a shared pair of Keys, meaning that ALL Scenarios registered with this pair of keys are public accessible!

DO NOT register private information using this keys!

Would you like to test on a private environment? Contact us to get a private pair of keys!

To import the environment clicking on the Import button

Import button

Select the downloaded file clicking on Upload Files button

Import button 02

After importing the environment, change the company variable to your company name: Result

Usage

With both the collection and the environment imported, create any Scenario you like and test them. Remember that this is a shared environment and de Scenarios and data generated are public and will be periodically deleted!