Pact

https://docs.pact.io
Admin
Pact is a contract testing framework that enables teams to verify that microservices and APIs can...
Tokens:906,646
Snippets:6,324
Trust Score:8.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install CMake build for examples

Source: https://docs.pact.io/implementation_guides/rust/pact_ffi

Install the built artifacts to the local install directory before building examples.

```bash
$ cmake --install . --prefix ./install  

```

--------------------------------

### Add repositories and install Pact Broker (TL;DR)

Source: https://docs.pact.io/pact_broker/kubernetes/readme

Quick start commands to add the Bitnami and Pact Broker chart repositories, then install the Pact Broker chart.

```shell
helm repo add bitnami https://charts.bitnami.com/bitnami  
helm repo add pact-broker https://pact-foundation.github.io/pact-broker-chart/  
  
helm install pact-broker pact-broker/pact-broker  

```

--------------------------------

### gRPC server startup output

Source: https://docs.pact.io/implementation_guides/pact_plugins/examples/grpc/area_calculator/provider-jvm

Example output when starting the gRPC server via Gradle.

```text
gRPC/area_calculator/provider-jvm:   
❯ ./gradlew run  
Starting a Gradle Daemon (subsequent builds will be faster)  
  
> Task :server:run  
14:21:59.427 [main] DEBUG io.netty.util.internal.logging.InternalLoggerFactory - Using SLF4J as the default logging framework  
14:21:59.439 [main] DEBUG io.netty.util.internal.PlatformDependent0 - -Dio.netty.noUnsafe: false  
14:21:59.439 [main] DEBUG io.netty.util.internal.PlatformDependent0 - Java version: 11  
14:21:59.441 [main] DEBUG io.netty.util.internal.PlatformDependent0 - sun.misc.Unsafe.theUnsafe: available  
14:21:59.442 [main] DEBUG io.netty.util.internal.PlatformDependent0 - sun.misc.Unsafe.copyMemory: available  
14:21:59.442 [main] DEBUG io.netty.util.internal.PlatformDependent0 - java.nio.Buffer.address: available  
14:21:59.444 [main] DEBUG io.netty.util.internal.PlatformDependent0 - direct buffer constructor: unavailable  
java.lang.UnsupportedOperationException: Reflective setAccessible(true) disabled  
        at io.netty.util.internal.ReflectionUtil.trySetAccessible(ReflectionUtil.java:31)  
        at io.netty.util.internal.PlatformDependent0$4.run(PlatformDependent0.java:239)  
        at java.base/java.security.AccessController.doPrivileged(Native Method)  
        at io.netty.util.internal.PlatformDependent0.<clinit>(PlatformDependent0.java:233)  
        at io.netty.util.internal.PlatformDependent.isAndroid(PlatformDependent.java:294)  
        at io.netty.util.internal.PlatformDependent.<clinit>(PlatformDependent.java:93)  
        at io.netty.util.AsciiString.<init>(AsciiString.java:223)  
        at io.netty.util.AsciiString.<init>(AsciiString.java:210)  
        at io.netty.util.AsciiString.cached(AsciiString.java:1401)  
        at io.netty.util.AsciiString.<clinit>(AsciiString.java:48)  
        at io.grpc.netty.Utils.<clinit>(Utils.java:78)  
        at io.grpc.netty.NettyServerBuilder.<clinit>(NettyServerBuilder.java:83)  
        at io.grpc.netty.NettyServerProvider.builderForPort(NettyServerProvider.java:40)  
        at io.grpc.netty.NettyServerProvider.builderForPort(NettyServerProvider.java:25)  
        at io.grpc.ServerBuilder.forPort(ServerBuilder.java:44)  
        at io.pact.example.grpc.provider.Server.<init>(Server.kt:12)  
        at io.pact.example.grpc.provider.ServerKt.main(Server.kt:71)  
        at io.pact.example.grpc.provider.ServerKt.main(Server.kt)  
14:21:59.445 [main] DEBUG io.netty.util.internal.PlatformDependent0 - java.nio.Bits.unaligned: available, true  
14:21:59.446 [main] DEBUG io.netty.util.internal.PlatformDependent0 - jdk.internal.misc.Unsafe.allocateUninitializedArray(int): unavailable  
java.lang.IllegalAccessException: class io.netty.util.internal.PlatformDependent0$6 cannot access class jdk.internal.misc.Unsafe (in module java.base) because module java.base does not export jdk.internal.misc to unnamed module @f0f2775  
        at java.base/jdk.internal.reflect.Reflection.newIllegalAccessException(Reflection.java:361)  
        at java.base/java.lang.reflect.AccessibleObject.checkAccess(AccessibleObject.java:591)  
        at java.base/java.lang.reflect.Method.invoke(Method.java:558)  
        at io.netty.util.internal.PlatformDependent0$6.run(PlatformDependent0.java:353)  
        at java.base/java.security.AccessController.doPrivileged(Native Method)  
        at io.netty.util.internal.PlatformDependent0.<clinit>(PlatformDependent0.java:344)  
        at io.netty.util.internal.PlatformDependent.isAndroid(PlatformDependent.java:294)  
        at io.netty.util.internal.PlatformDependent.<clinit>(PlatformDependent.java:93)  
```

--------------------------------

### GitHub Actions example: Install Pact via Scoop

Source: https://docs.pact.io/implementation_guides/cli

GitHub Actions workflow step that installs the unified Pact CLI via Scoop on Windows runners and verifies with pact --help.

```yaml
- name: Install Pact via Scoop  
  if: runner.os == 'Windows'  
  shell: powershell  
  run: |  
    scoop bucket add pact https://github.com/pact-foundation/scoop  
    scoop install pact  
    scoop search pact  
    pact --help  
```

--------------------------------

### Manual download of Pact FFI library (macOS example)

Source: https://docs.pact.io/implementation_guides/go/readme

Downloads and installs the Pact FFI library for macOS. Adjust the URL and extension for your OS.

```bash
wget https://github.com/pact-foundation/pact-reference/releases/download/libpact_ffi-v0.4.21/libpact_ffi-macos-x86_64.dylib.gz  
gunzip libpact_ffi-macos-x86_64.dylib.gz  
mv libpact_ffi-macos-x86_64.dylib /usr/local/lib/libpact_ffi.dylib  

```

--------------------------------

### Show help for the start subcommand

Source: https://docs.pact.io/implementation_guides/cli/pact-mock-server

Running `./pact-mock-server help start` displays the help for the `start` subcommand, which starts the master mock server. This server must be running for other subcommands to work.

```bash
$ ./pact-mock-server help start  
Starts the master mock server  
  
Usage: pact-mock-server start [OPTIONS]  
  
Options:  
      --help                     Print help and exit  
  -o, --output <output>          the directory where to write files to (defaults to current directory)  
      --base-port <base-port>    the base port number that mock server ports will be allocated from. If not specified, ports will be randomly assigned by the OS.  
  -v, --version                  Print version information and exit  
  -p, --port <port>              port the master mock server runs on (defaults to 8080)  
      --server-key <server-key>  the server key to use to authenticate shutdown requests (defaults to a random generated one)  
  -h, --host <host>              hostname the master mock server runs on (defaults to localhost)  
  -l, --loglevel <loglevel>      Log level for mock servers to write to the log file (defaults to info) [possible values: error, warn, info, debug, trace, none]  
      --no-term-log              Turns off using terminal ANSI escape codes  
      --no-file-log              Do not log to an output file  
  
  

```

--------------------------------

### Install commitizen and conventional changelog CLI tools

Source: https://docs.pact.io/implementation_guides/javascript/contributing

Install commitizen and cz-conventional-changelog globally to get CLI assistance for commit messages. After installation, use 'git cz' to commit with commitizen guiding you.

```bash
npm install commitizen -g  
npm i -g cz-conventional-changelog  
```

--------------------------------

### Run make bin and start the plugin

Source: https://docs.pact.io/plugins/workshops/create-a-plugin/step4

Run `make bin` to create the plugin, then start it with `build/myplugin`. The plugin outputs a JSON line with the port and server key, which the Plugin Driver reads to register the plugin.

```bash
make bin
```

```bash
build/myplugin
```

--------------------------------

### Install dependencies with bundle install

Source: https://docs.pact.io/implementation_guides/ruby/readme_v2

Installs the Ruby gems required for the project. Run this once during setup before executing any tests.

```bash
bundle install  
```

--------------------------------

### GET / endpoint example

Source: https://docs.pact.io/implementation_guides/jvm/pact-jvm-server

Example request to the / endpoint for diagnostics, returning all currently running mock server port numbers.

```http
    GET http://localhost:29999/  
  
        '{ "ports": [23443,43232] }'  

```

--------------------------------

### pact-mock-server create help output

Source: https://docs.pact.io/implementation_guides/cli/pact-mock-server

Shows the help text for the 'create' command, listing all options such as --file, --port, --specification, --tls, and log level settings. The --file option is mandatory.

```bash
$ ./pact-mock-server help create  
Creates a new mock server from a pact file  
  
Usage: pact-mock-server create [OPTIONS] --file <file>  
  
Options:  
  -f, --file <file>                    the pact file to define the mock server  
      --help                           Print help and exit  
  -c, --cors-preflight                 Handle CORS pre-flight requests  
  -v, --version                        Print version information and exit  
  -p, --port <port>                    port the master mock server runs on (defaults to 8080)  
      --specification <specification>  The Pact specification version to use (defaults to V4)  
  -h, --host <host>                    hostname the master mock server runs on (defaults to localhost)  
      --tls                            Enable TLS with the mock server (will use a self-signed certificate)  
  -l, --loglevel <loglevel>            Log level for mock servers to write to the log file (defaults to info) [possible values: error, warn, info, debug, trace, none]  
      --no-term-log                    Turns off using terminal ANSI escape codes  
      --no-file-log                    Do not log to an output file  
  
  

```

--------------------------------

### List installed plugins and their contents

Source: https://docs.pact.io/implementation_guides/pact_plugins/docs/writing-plugin-guide

Shows the directory structure of installed plugins in ~/.pact/plugins, including the csv and protobuf example plugins and their files.

```bash
$ ls -l ~/.pact/plugins/  
total 8  
drwxrwxr-x 2 ronald ronald 4096 Oct 18 14:09 csv-0.0.0  
drwxrwxr-x 6 ronald ronald 4096 Oct 13 15:21 protobuf-0.0.0  
  
$ ls -l ~/.pact/plugins/csv-0.0.0/  
total 12376  
-rwxrwxr-x 1 ronald ronald 12667032 Oct  6 12:04 pact-plugin-csv  
-rw-rw-r-- 1 ronald ronald      237 Oct 18 14:09 pact-plugin.json  
  
$ ls -l ~/.pact/plugins/protobuf-0.0.0/  
total 28  
drwxr-xr-x 2 ronald ronald  4096 Aug 27 12:40 bin  
drwxr-xr-x 2 ronald ronald 12288 Oct 13 12:23 lib  
-rw-rw-r-- 1 ronald ronald   352 Oct 11 11:07 pact-plugin.json  
drwxrwxr-x 2 ronald ronald  4096 Oct 18 13:33 tmp  

```

--------------------------------

### GET /webhooks Response Body

Source: https://docs.pact.io/pact_broker/api/webhooks

Example response body for a GET request to /webhooks. Shows the HAL+JSON structure with links to the webhooks collection and a specific webhook.

```json
{  
  "_links": {  
    "self": {  
      "title": "Webhooks",  
      "href": "http://example.org/webhooks"  
    },  
    "pb:create": {  
      "title": "POST to create a webhook",  
      "href": "http://example.org/webhooks"  
    },  
    "pb:webhooks": [  
      {  
        "title": "A webhook for the pact between Foo and Bar",  
        "name": "an example webhook",  
        "href": "https://pact-broker/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac"  
      }  
    ],  
    "curies": [  
      {  
        "name": "pb",  
        "href": "https://pact-broker/doc/webhooks-{rel}",  
        "templated": true  
      }  
    ]  
  }  
}  

```

--------------------------------

### Show main help for pact-mock-server

Source: https://docs.pact.io/implementation_guides/cli/pact-mock-server

Running `./pact-mock-server --help` displays the standard help output, listing flags, options, and subcommands. The binary is named `pact-mock-server` and implements the V4 Pact specification.

```bash
$ ./pact-mock-server --help  
./pact-mock-server v1.0.0  
Standalone Pact mock server  
  
USAGE:  
    pact-mock-server [FLAGS] [OPTIONS] <SUBCOMMAND>  
  
FLAGS:  
        --help           Prints help information  
        --no-file-log    Do not log to an output file  
        --no-term-log    Use a simple logger instead of the term based one  
    -v, --version        Prints version information  
  
OPTIONS:  
    -h, --host <host>            hostname the master mock server runs on (defaults to localhost)  
    -l, --loglevel <loglevel>    Log level for mock servers to write to the log file (defaults to info) [possible  
                                 values: error, warn, info, debug, trace, none]  
    -p, --port <port>            port the master mock server runs on (defaults to 8080)  
  
SUBCOMMANDS:  
    create             Creates a new mock server from a pact file  
    help               Prints this message or the help of the given subcommand(s)  
    list               Lists all the running mock servers  
    shutdown           Shutdown the mock server by id or port number, releasing all its resources  
    shutdown-master    Performs a graceful shutdown of the master server (displayed when it started)  
    start              Starts the master mock server  
    verify             Verify the mock server by id or port number, and generate a pact file if all ok  
  
  

```

--------------------------------

### Show pact-broker-cli create-environment help

Source: https://docs.pact.io/implementation_guides/cli/pact-broker-cli

Displays the full help and usage for the `create-environment` command, listing all options, defaults, and environment variables. Use it to see required flags (`--name`, `--broker-base-url`) and available authentication, SSL, OpenTelemetry, and logging settings.

```bash
$ pact-broker-cli create-environment --help  
Create an environment resource in the Pact Broker to represent a real world deployment or release environment  
  
Usage: pact-broker-cli create-environment [OPTIONS] --name <NAME> --broker-base-url <PACT_BROKER_BASE_URL>  
  
Options:  
      --name <NAME>  
          The uniquely identifying name of the environment as used in deployment code  
      --display-name <DISPLAY_NAME>  
          The display name of the environment  
      --production  
          Whether or not this environment is a production environment. This is currently informational only.  
      --contact-name <CONTACT_NAME>  
          The name of the team/person responsible for this environment  
      --contact-email-address <CONTACT_EMAIL_ADDRESS>  
          The email address of the team/person responsible for this environment  
  -o, --output <OUTPUT>  
          Value must be one of ["json", "text", "id"] [default: text] [possible values: json, text, id]  
  -b, --broker-base-url <PACT_BROKER_BASE_URL>  
          The base URL of the Pact Broker [env: PACT_BROKER_BASE_URL=]  
  -u, --broker-username <PACT_BROKER_USERNAME>  
          Pact Broker basic auth username [env: PACT_BROKER_USERNAME=]  
  -p, --broker-password <PACT_BROKER_PASSWORD>  
          Pact Broker basic auth password [env: PACT_BROKER_PASSWORD=]  
  -k, --broker-token <PACT_BROKER_TOKEN>  
          Pact Broker bearer token [env: PACT_BROKER_TOKEN=]  
      --custom-header <HEADER>  
          Custom header(s) to send with requests (format: 'Header-Name: Value', can be used multiple times)  
  -c, --ssl-certificate <SSL_CERT_FILE>  
          The path to a valid SSL certificate file [env: SSL_CERT_FILE=]  
      --skip-ssl-verification  
          Skip SSL certificate verification [env: SSL_SKIP_VERIFICATION=]  
      --ssl-trust-store <SSL_TRUST_STORE>  
          Use the system's root trust store for SSL verification [env: SSL_TRUST_STORE=] [default: true] [possible values: true, false]  
      --enable-otel  
          Enable OpenTelemetry tracing  
      --enable-otel-logs  
          Enable OpenTelemetry logging  
      --enable-otel-traces  
          Enable OpenTelemetry traces  
      --otel-exporter <otel-exporter>  
          The OpenTelemetry exporter(s) to use, comma separated (stdout, otlp) [env: OTEL_TRACES_EXPORTER=]  
      --otel-exporter-endpoint <otel-exporter-endpoint>  
          The endpoint to use for the OTLP exporter (required if --otel-exporter=otlp) [env: OTEL_EXPORTER_OTLP_ENDPOINT=]  
      --otel-exporter-protocol <otel-exporter-protocol>  
          The protocol to use for the OTLP exporter (http/protobuf, http) [env: OTEL_EXPORTER_OTLP_PROTOCOL=] [default: http] [possible values: http, http/protobuf]  
      --log-level <LEVEL>  
          Set the log level (none, off, error, warn, info, debug, trace) [default: off] [possible values: off, none, error, warn, info, debug, trace]  
  -h, --help  
          Print help  
  

```

--------------------------------

### GET /webhooks/:uuid - Response Body

Source: https://docs.pact.io/pact_broker/api/webhooks

Example response body for a GET request to retrieve a webhook. Shows the full webhook representation including links.

```json
{  
  "uuid": "d2181b32-8b03-4daf-8cc0-d9168b2f6fac",  
  "description": "an example webhook",  
  "consumer": {  
    "name": "Foo"  
  },  
  "provider": {  
    "name": "Bar"  
  },  
  "enabled": true,  
  "request": {  
    "method": "POST",  
    "url": "https://example.org/webhook",  
    "headers": {  
      "Content-Type": "application/json"  
    },  
    "body": {  
      "pactUrl": "${pactbroker.pactUrl}"  
    }  
  },  
  "events": [  
    {  
      "name": "contract_content_changed"  
    }  
  ],  
  "createdAt": "2021-09-01T00:07:21+00:00",  
  "_links": {  
    "self": {  
      "title": "an example webhook",  
      "href": "https://pact-broker/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac"  
    },  
    "pb:execute": {  
      "title": "Test the execution of the webhook with the latest matching pact or verification by sending a POST request to this URL",  
      "href": "https://pact-broker/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac/execute"  
    },  
    "pb:consumer": {  
      "title": "Consumer",  
      "name": "Foo",  
      "href": "https://pact-broker/pacticipants/Foo"  
    },  
    "pb:provider": {  
      "title": "Provider",  
      "name": "Bar",  
      "href": "https://pact-broker/pacticipants/Bar"  
    },  
    "pb:pact-webhooks": {  
      "title": "All webhooks for consumer Foo and provider Bar",  
      "href": "https://pact-broker/webhooks/provider/Bar/consumer/Foo"  
    },  
    "pb:webhooks": {  
      "title": "All webhooks",  
      "href": "https://pact-broker/webhooks"  
    }  
  }  
}  

```

--------------------------------

### GET /webhooks/provider/:provider_name response

Source: https://docs.pact.io/pact_broker/api/webhooks

Example response body for a GET request to the provider webhooks endpoint. Returns a HAL+JSON document with links for self, create, and webhooks.

```json
{  
  "_links": {  
    "self": {  
      "title": "Webhooks",  
      "href": "http://example.org/webhooks/provider/Bar"  
    },  
    "pb:create": {  
      "title": "POST to create a webhook",  
      "href": "http://example.org/webhooks/provider/Bar"  
    },  
    "pb:webhooks": [  
  
    ],  
    "curies": [  
      {  
        "name": "pb",  
        "href": "https://pact-broker/doc/webhooks-{rel}",  
        "templated": true  
      }  
    ]  
  }  
}  

```

--------------------------------

### Create production environment example

Source: https://docs.pact.io/pact_broker/recording_deployments_and_releases

Example command to create a production environment named 'customer-1-production' with display name 'Customer 1 Production'.

```bash
$ pact-broker create-environment --name customer-1-production --display-name "Customer 1 Production" --production
```

--------------------------------

### Install from local clone

Source: https://docs.pact.io/ai_tools/installation

Adds the marketplace from a local clone and installs the plugin.

```bash
/plugin marketplace add ./path/to/pactflow-agent-skills/.claude-plugin/marketplace.json  
/plugin install swagger-contract-testing@pactflow-agent-skills  

```

--------------------------------

### GET /webhooks/consumer/:consumer_name response

Source: https://docs.pact.io/pact_broker/api/webhooks

Example response body for a GET request to the consumer webhooks endpoint. Returns a HAL+JSON document with links for self, create, and webhooks.

```json
{  
  "_links": {  
    "self": {  
      "title": "Webhooks",  
      "href": "http://example.org/webhooks/consumer/Foo"  
    },  
    "pb:create": {  
      "title": "POST to create a webhook",  
      "href": "http://example.org/webhooks/consumer/Foo"  
    },  
    "pb:webhooks": [  
  
    ],  
    "curies": [  
      {  
        "name": "pb",  
        "href": "https://pact-broker/doc/webhooks-{rel}",  
        "templated": true  
      }  
    ]  
  }  
}  

```

--------------------------------

### pact-mock-server create example

Source: https://docs.pact.io/implementation_guides/cli/pact-mock-server

Example of creating a mock server from a pact file. The output shows the mock server ID and port.

```bash
$ ./pact-mock-server create -f ../../../libpact_matching/tests/pact.json  
15:43:47 [INFO] pact_mock_server_cli::create_mock: Creating mock server from file ../../../libpact_matching/tests/pact.json  
Mock server "7d1bf906d0ff42528f2d7d794dd19c5b" started on port 52943  

```

--------------------------------

### Manual installation commands for SmartBear MCP server

Source: https://docs.pact.io/ai_tools/smartbear-mcp

Commands for manual setup: Claude Code uses a plugin install, while other tools run the MCP server via npx.

```bash
# Claude Code — plugin install handles this automatically  
/plugin install swagger-contract-testing@pactflow-agent-skills  
  
# All other tools — run the MCP server via npx  
npx @smartbear/mcp@latest  
```

--------------------------------

### contract-testing_can_i_deploy example

Source: https://docs.pact.io/ai_tools/smartbear-mcp

Example prompt for the deployment safety gate. Replace the pacticipant, version, and environment with actual values.

```text
Is FrontendApp version abc123 safe to deploy to production?  
```

--------------------------------

### Windsurf: Project-level manual install

Source: https://docs.pact.io/ai_tools/installation

Creates the .windsurf/skills directory and copies the drift-testing, openapi-parser, and pactflow skills into it. Commit .windsurf/skills/ to share with your team.

```bash
mkdir -p .windsurf/skills  
cp -r plugins/swagger-contract-testing/skills/drift-testing .windsurf/skills/drift-testing  
cp -r plugins/swagger-contract-testing/skills/openapi-parser .windsurf/skills/openapi-parser  
cp -r plugins/swagger-contract-testing/skills/pactflow .windsurf/skills/pactflow  

```

--------------------------------

### Install CSV plugin with pact-plugin -y

Source: https://docs.pact.io/implementation_guides/cli/pact-plugin

Example command and output for installing the CSV plugin version 0.0.1 from a GitHub release URL. The -y option automatically answers yes to prompts, and the output shows the download progress and successful installation.

```shell
$ pact-plugin -y install https://github.com/pact-foundation/pact-plugins/releases/tag/csv-plugin-0.0.1  
Installing plugin csv version 0.0.1  
Downloaded https://github.com/pact-foundation/pact-plugins/releases/download/csv-plugin-0.0.1/pact-csv-plugin-linux-x86_64.gz to /home/ronald/.pact/plugins/csv-0.0.1/pact-csv-plugin-linux-x86_64.gz  
  [00:00:03] [#######################################################################################################################################################################] 3.43MiB/3.43MiB (973.64KiB/s, 0s)  
Downloaded https://github.com/pact-foundation/pact-plugins/releases/download/csv-plugin-0.0.1/pact-csv-plugin-linux-x86_64.gz.sha256 to /home/ronald/.pact/plugins/csv-0.0.1/pact-csv-plugin-linux-x86_64.gz.sha256  
  [00:00:00] [#############################################################################################################################################################################] 115B/115B (185.98KiB/s, 0s)  
Installed plugin csv version 0.0.1 OK  

```

--------------------------------

### pact-broker-cli can-i-deploy: basic usage, example, and can-I-merge check

Source: https://docs.pact.io/implementation_guides/cli/pact-broker-cli

Shows the basic can-i-deploy command syntax, a concrete example checking version 173153ae0 of Foo against the test environment, and a 'can I merge' style check comparing Foo version 173153ae0 with the latest main branch of Bar. The last command uses a comment marker '//' to separate pacticipant arguments.

```bash
$ pact-broker-cli can-i-deploy --pacticipant PACTICIPANT --version VERSION --to-environment ENVIRONMENT
```

```bash
$ pact-broker-cli can-i-deploy --pacticipant Foo --version 173153ae0 --to-environment test
```

```bash
$ pact-broker-cli can-i-deploy --pacticipant Foo 173153ae0 // --pacticipant Bar --latest main
```

--------------------------------

### Start mock service with pact.serve()

Source: https://docs.pact.io/implementation_guides/python/docs/consumer

Use the pact object as a context manager with pact.serve() to start the mock service. The service selects a random free port by default, but you can specify a custom host and port. The example shows creating a UserClient with the service URL and fetching a user.

```python
with pact.serve(host="localhost", port=1234) as srv:  
    client = UserClient(str(srv.url))  
    user = client.get_user(123)  

```

--------------------------------

### POST /create endpoint example

Source: https://docs.pact.io/implementation_guides/jvm/pact-jvm-server

Example request to the /create endpoint to initialize a mock server with expected interactions and a state query parameter. The server starts on a random port and returns it in the 201 response.

```http
    POST http://localhost:29999/create?state=NoUsers&path=/sub/ref/path '{ "provider": { "name": "Animal_Service"}, ... }'  

```

```json
    { "port" : 34423 }  

```

--------------------------------

### GitHub Actions example: Install Pact via Chocolatey

Source: https://docs.pact.io/implementation_guides/cli

GitHub Actions workflow step that installs the Pact Unified CLI via Chocolatey on Windows, handling ARM64 architecture with the ForceARM64 parameter.

```yaml
- name: Install Pact via Chocolatey  
  if: runner.os == 'Windows'  
  shell: powershell  
  run: |  
    curl https://github.com/pact-foundation/choco/releases/download/choco/pact.0.9.1.nupkg -OutFile pact.nupkg  
    if ("${{ runner.arch }}" -eq "ARM64") {  
      choco install -y pact --source . --params "'/ForceARM64:true'"  
    } else {  
      choco install -y pact --source .  
    }  
    pact --help  
```
Tokens:
Raw