Copycat
Copycat User Guide
Overview
Copycat is an application designed to help developers to test their applications
by providing an easy way to mock external systems that are accessed by the application under development.
With Copycat you can quickly mock applications to create POCs or even provide a Sandbox of your own application to speed up the integration with other teams, while your application is not ready.
Supported Protocols
Copycat is an extensible application that can provide mocks for multiple protocols. So far, the supported protocols are:
Each protocol have its particular configurations/properties and those are explained on the protocol's specific page.
Authentication
Copycat uses a pair of API Keys to authenticate the requesting user.
API Key
This API Key is used for administrative purposes, like managing scenarios or managing resources that are used by specific protocols (like ISO8583 port mapping).
Copycat expects this key to be passed as a header X-Api-Key on every administrative request made.
IMPORTANT: The Key should not be shared, as anyone with access to this key will be able to manage the all saved data.
Read API Key
In order to use the registered Scenarios, it is necessary to inform the Read API KEY. The key only grants access to use the registered Scenarios, so, it is not possible to retrieve or modify the Scenarios.
Each protocol have its particular way to use the Read API Key, please refer to the protocol's specific page.
Scenarios
On Copycat, each mock you make is described as a Scenario and Scenarios related to the same endpoint/feature are grouped under the same ScenarioKey. When Copycat receives a request, it will parse a ScenarioKey with the request information, load the available Scenarios and find which one matches the given request. Then, the response associated with the matched Scenario will be returned, and after that, the associated commands/callbacks will be executed.
The Scenario declaration section provides details on how to declare your Scenarios.