proxymock service examples

Use the examples in this repository as pre-built mock servers or simulators for common APIs (or services) like AWS or GCP. Each example will runs a mock server that will serve responses like the real API.

⬇️ Installation

1. Install proxymock

   If you haven't yet, install proxymock. The best way is to follow the installation guide. However, if you're impatient like us, you can do it in one simple command:

   brew install speedscale/tap/proxymock
   proxymock init

   Note that proxymock automatically decodes TLS traffic if given permission. You will be asked to modify your local keystore to allow this optional feature. This is a good spot to point out that proxymock does not send data (other than telemetry) to any third party. Feel free to disallow anyway as non-TLS will still work.

2. Pick a Snpashot

   Pick the appropriate .jsonl from this repository. Import it into proxymock with the following command:

   proxymock import --file foo.jsonl

   Take note of the imported snapshot ID from the output.

   If you want to see the contents of the snapshot in a fancy tui you can run:

   proxymock inspect snapshot [snapshot-id]

📊 Usage

1. Start Mock Server

   proxymock run --snapshot-id [id]

2. Run Your App

   If your outbound calls respect environment variables, you should paste the following into the terminal you run your app in:

   export http_proxy=http://localhost:4140
   export https_proxy=http://localhost:4140

   If your app uses civilized SDKs then it will cause your app to redirect outbound traffic to the mock server. If this doesn't work you need to find the right environment variables for the app you use or modify the endpoints in your code.

📏 Limitations

• Mocks are not language dependent since they are network servers. Major revisions of an API may require a different snapshot. For instance, v2 of the AWS API has a different network format than v1.
• This repository contains the formatting and stub data necessary for each mocked service, but will want to modify the mocks to add realistic responses for your app. You can do that by modifying the .jsonl. Pro users can also record from a live environment (see enterprise features).

📸 What Are Snapshots?

Snapshots are recordings of API requests to cloud services like OpenAI API, AWS DynamoDB, S3, BigQuery, or BigTable. Think of them as time capsules of API interactions—except instead of burying them in your backyard, we use them to mock APIs like a boss with proxymock.

🖊️ Modifying a Snapshot

To change the response returned for a particular request:

1. Find the line in the snapshot (.jsonl file) representing the request you want to modify. You can modify a file in this repository directly or if you have already imported the file it will be stored in ~/.speedscale/data/snapshots/[snapshot-id]/raw.jsonl.
2. Encode your new payload into base64 format.
3. Find the JSON key http.res.bodyBase64.
4. Replace the existing value. You can modify any other aspect of the request or response as well. If you modify the request then the mock server will attempt to match the new query parameters, etc that you input to the response on the same line.
5. Re-analyze your mock by running proxymock analyze [snapshot-id]. If you have not yet imported it then just run proxymock import --file foo.jsonl and it will automatically be analyzed as part of the import process.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

🛠 Contributing

Please visit our contributions page for more information.