Quick Start

Authentication requires valid PactFlow API Tokens, which can be obtained from the Settings > Tokens page of your API Hub for Contract Testing organization.

Set the following environment variables, and the CLI will use them to communicate with API Hub for Contract Testing:

export PACT_BROKER_BASE_URL="https://YOUR_ORG.pactflow.io"
export PACT_BROKER_TOKEN="YOUR_TOKEN"

Learn more about other ways of configuring PactFlow AI.

To generate Pact tests use the pactflow-ai generate subcommand. There are 3 sources that may be used for generation, including openapi, code and request-response.

Let's assume we have a simple Product API for which we would like to create Pact tests, described by the following OpenAPI description:

products.yml

openapi: 3.0.1
info:
  title: Product API
  description: Pactflow Product API demo
  version: 1.0.0
paths:
  /product/{id}:
    get:
      summary: Find product by ID
      description: Returns a single product
      operationId: getProductByID
      parameters:
      - name: id
        in: path
        description: Product ID
        schema:
          type: string
        required: true
      responses:
        "200":
          description: successful operation
          content:
            "application/json; charset=utf-8":
              schema:
                $ref: '#/components/schemas/Product'
        "404":
          description: Product not found
          content: {}
components:
  schemas:
    Product:
      type: object
      required:
        - id
        - name
        - price
      properties:
        id:
          type: string
        type:
          type: string
        name:
          type: string
        version:
          type: string
        price:
          type: number

Be sure to update the paths as necessary. Executing the command should produce something like this:

// Generated by PactFlow// Timestamp: 2025-02-11T00:34:14.067426+00:00// Reference: 06TzSdaSlI4iKH1zIdghimport { PactV3, MatchersV3 } from "@pact-foundation/pact";import { API } from "./src/api";describe('Consumer Pact with Product Service', () => {  const provider = new PactV3({    consumer: 'ProductConsumer',    provider: 'ProductService',  });  describe('Pact for getProductByID', () => {    it('returns a product by ID', () => {      provider        .given('a product with ID exists')        .uponReceiving('a request to get a product by ID')        .withRequest({          method: 'GET',          path: MatchersV3.regex('/product/[a-zA-Z0-9]+', '/product/123'),          headers: {            'Authorization': MatchersV3.regex('Bearer [a-zA-Z0-9]+', 'Bearer token123'),            'Content-Type': 'application/json; charset=utf-8'          }        })        .willRespondWith({          status: 200,          headers: {            'Content-Type': 'application/json; charset=utf-8'          },          body: MatchersV3.like({            id: MatchersV3.string('123'),            name: MatchersV3.string('Product Name'),            price: MatchersV3.number(99.99),            type: MatchersV3.string('Product Type'),            version: MatchersV3.string('1.0')          })        });      return provider.executeTest(async (mockserver) => {        const api = new API(mockserver.url);        const product = await api.getProduct('123');        expect(product).to.deep.equal({          id: '123',          name: 'Product Name',          price: 99.99,          type: 'Product Type',          version: '1.0'        });      });    });  });});

And it's done! Of course, this test won't work without being a part of a real project, but hopefully, you can see how you can quickly generate Pact tests using PactFlow AI, saving time and improving accuracy.