Contract Testing Documentation
Guides and reference material for Contract Testing.
User Guide
- User GuideGetting Started with Swagger Contract Testing
- Getting Started with Swagger Contract TestingYou need the following prerequisites to get started with Swagger Contract Testing:
- User InterfaceUser Interface 1.x.x (On-Premises)
- User Interface 1.x.x (On-Premises)Dashboard
- DashboardThe main Swagger Contract Testing screen has four functional areas.
- Bi-Directional Contract TestingThis section describes the Bi-directional Contract Testing screens in Swagger Contract Testing On-Premises. Bi-Directional Contract Testing is a type of…
- Can I DeployCan I Deploy page is the web version of our popular CLI tool can-i-deploy, which queries the "Matrix". This UI provides a rich query interface for the…
- SettingsAPI Tokens
- API TokensAbout
- PreferencesIn this screen, you can see which settings you can modify in Swagger Contract Testing On-Premises Preferences panels. There are two types of preferences:
- WebhooksHere you can create and edit your webhooks.
- SecretsYou can create your own variables to store sensitive values like usernames and passwords here. These will be encrypted and stored in the Swagger Contract…
- UsersOur User Management feature allows you to manage the following capabilities:
- EnvironmentsHere you can manage the list of environments used by your organization. These represent your real-world deployment or release environments. Maintaining…
- TeamsOur Team Management feature allows you to manage the following capabilities:
- User Interface 2.x.xDashboard
- DashboardThis screen helps you quickly find and access your applications.
- ApplicationApplications, also called Pacticipants, are at the center of the Swagger Contract Testing experience.
- IntegrationThis page provides compatibility details for a specific integration.
- Contract DetailsThis section describes the contract details page in Swagger Contract Testing. The contract details page displays a comprehensive breakdown of the contract…
- Bi-Directional Contract TestingThis section describes the Bi-directional Contract Testing screens in Swagger Contract Testing. Bi-Directional Contract Testing is a type of static…
- SettingsAPI Tokens
- API TokensThis screen helps you copy and re-generate your API tokens. There are two types of API tokens you can use:
- PreferencesIn this screen, you can see which settings you can modify in Swagger Contract Testing Preferences panels. There are two types of preferences:
- WebhooksWebhooks allow you to trigger an HTTP request when an event happens in Swagger Contract Testing. For example, when pact is changed, a pact is published,…
- SecretsYou can create your own variables to store sensitive values like usernames and passwords here. These will be encrypted and stored in the Swagger Contract…
- UsersThe User Management feature allows you to manage some user capabilities directly in Swagger Contract Testing. When it comes to the organization roles, you…
- System AccountsSystem accounts are user accounts specifically for API access, primarily used with CI/CD systems to access Swagger Contract Testing. They are intended for…
- TeamsOur Team Management feature allows you to manage the following capabilities:
- RolesSwagger Contract Testing comes with a number of default roles. You can create custom roles to tailor the role-based access model to your security needs.…
- EnvironmentsHere you can manage the list of environments used by your organization. These represent your real-world deployment or release environments. Maintaining…
- FeaturesAI
- AIIntroduction
- Test Generation featuring AISwagger Contract Testing Test Generation is an AI-powered tool that rapidly creates Pact tests from source code, OpenAPI descriptions, or traffic capture…
- Quick StartThis feature is enabled by default in all organizations. However, if your organization is older, it may be disabled.
- Using AITo generate Pact tests, use the pactflow-ai generate command.
- Managing AIAccess to the feature is limited by a credit system, where each generated test uses one credit. Credits reset on the first day of each calendar month, and…
- AI SkillsYou can discover and install AI Skills directly from the AI page in Swagger Contract Testing. Open AI from the left navigation menu to view the available…
- TroubleshootingIf you encounter the following error:
- Further LearningWe've created an in-browser tutorial to help you get started with Swagger Contract Testing's test generation feature.
- StubsEvery consumer contract published to Swagger Contract Testing is automatically assigned a hosted API stub URL that you can use for stubbing API backends…
- Roles and permissionsOverview
- Role-Based Access ControlSwagger Contract Testing uses a flexible team-based Role-Based Access Control (RBAC) model to manage access to contracts, applications, and features. This…
- Predefined rolesEligible plans: Enterprise
- PermissionsEligible plans: Enterprise
- API token permissionsAPI tokens inherit their permissions from their associated users.
- AuthenticationSwagger Contract Testing users authenticate with SmartBear ID. See the SmartBear ID Documentation to learn about the login process and options.
- Contract TestingPact
- PactSwagger Contract Testing supports all the features of the Open-Source Pact Broker and Pact framework, you can find the documentation at docs.pact.io.
- Bi-Directional Contract TestingOverview
- Bi-Directional Contract Testing GuideBi-Directional Contract Testing is a type of static contract testing where two contracts - one representing consumer expectations, and another…
- Consumer Testing GuideIt is important for you to use a mock and not a stub. The crucial difference is that a mock validates behaviour, whereas a stub does not. We need to…
- Provider Testing GuideTesting the provider API is your responsibility. Contract Testing ensures the specification is compatible with any consumers
- Publishing ContractsPublishing a consumer contract is the same as publishing a regular Pact. For details on publishing pact files to Swagger Contract Testing, refer to…
- Compatibility Checks (breaking change detection)When contracts are published to Swagger Contract Testing, the consumer contract (a pact file) will be verified against the provider contract — an OpenAPI…
- Deploying and ReleasingSwagger Contract Testing needs to know which versions of each application are in each environment so it can determine whether a particular application…
- Supported ContractsPact
- Pact Contracts* When using Pact specification V4, the following interaction types are validated:
- OpenAPI SpecificationOverview
- OpenAPI Specification ContractsProviders may specify an OpenAPI Specification as a Provider Contract, enabling teams to reuse existing tools and processes.
- FeaturesThis section lists the supported features and compatibility checks Swagger Contract Testing applies when comparing consumer contracts (pact files) against…
- Keyword SupportOpenAPI contracts may contain the logical keywords anyOf, allOf, and oneOf in schema definitions, which are used to support rich domain models, validate a…
- ConfigurationYou can customize the behavior of the comparison checks using OpenAPI extensions.
- ChangelogA new comparison engine released, up to 100x faster than the previous engine.
- AsyncAPI SpecificationYou can use an AsyncAPI definition as the provider contract for event-driven APIs in Swagger Contract Testing. AsyncAPI definitions work with the Contract…
- AsyncAPI Contracts - OverviewAsyncAPI definitions describe event-driven APIs. Swagger Contract Testing compares consumer message contracts against AsyncAPI provider contracts using…
- Features - Testing AsyncAPIWhen you verify a consumer contract against an AsyncAPI provider contract, Contract Testing performs these steps for each message interaction:
- Avro PayloadsContract Testing compares Avro message payloads in consumer contracts with Avro schemas in AsyncAPI provider contracts. Each payload goes through a value…
- Protobuf PayloadsContract Testing compares Protobuf message payloads in consumer contracts with Protobuf schemas in AsyncAPI provider contracts. Each payload goes through…
- Tool IntegrationOverview
- ToolsThe following are adapters for common tools that provide mocking capability that you can use to immediately generate pact files from:
- Tooling integration - Swagger StudioIn this guide, you'll learn how to use Contract Testing and Studio together, to add contract testing to your design first API development workflow.
- Tooling integration - CypressGenerate pact contracts from Cypress tests.
- Tooling integration - MSWCreate MSW (mock-service-worker) mocks and generate pact contracts from recorded interactions.
- Tooling integration - WiremockCaptures HTTP request/responses interactions with your WireMocks and generates Pact files. So, you can verify, via contract testing, that your mocks are…
- Tooling integration - WiremockCaptures HTTP request/responses interactions with your WireMocks and generates Pact files. So, you can verify, via contract testing, that your mocks are…
- IntegrationsSwagger Studio
- Swagger Studio IntegrationFor more information on integration and setup instructions, visit the Swagger Studio documentation.
- TroubleshootingGlossary
- GlossaryA "Pacticipant" is a party that participates in a pact (ie. a Consumer or a Provider as per above). It was once a clever name but there is now significant…
- Authorization ErrorsThe most common reasons for API authentication failures are:
- Webhooks / Public IPsIf you are having issues executing webhooks into your environment or accessing Contract Testing from your systems, you may need to whitelist our IP…
- PowerShell Migration guideSwagger Contract Testing will only support TLS1.2+ connections for Web and API access starting June 10th, 2020.
- Disabling dangerous contract modificationWhen a contract is published, it is associated with the application version that generated the contract.
- Slow responses when fetching pacts for verificationSlow responses when fetching pacts for verification when WIP pacts is enabled is caused by performance problems calculating the latest pact for each tag…
- Migration from PactFlow to Swagger Contract TestingThis guide helps you smoothly transition from standalone PactFlow to your new Swagger account.
- Migration FAQHere you can find the most frequent questions and doubts related to the migration from standalone PactFlow to Swagger Contract Testing.
- APIThe Swagger Contract Testing API is documented on our API Portal.
Swagger Contract Testing University
- Swagger Contract Testing UniversityOverview
- Swagger Contract Testing UniversityLearn how Pact works through a series of purpose built videos, workshops and training material.
- TutorialsWe've created a few short, in-browser tutorials using the Killercoda platform to get you up and running quickly depending on your level.
- Introduction to PactIntroduction
- Swagger Contract Testing - Introduction to PactUnderstand the problems with end-to-end integrated testing, including managing environments
- Learning Outcomeshttps://github.com/pact-foundation/pact-workshop-js
- Further ReadingThis introductory course provided via Test Automation University on contract testing with Pact is also a helpful resource.
- Consumer-Driven Contract Testing CI/CDIntroduction
- Consumer-Driven Contract Testing CI/CD WorkshopA workshop demonstrating how to set up a CI/CD pipeline for a consumer and provider using Pact, Swagger Contract Testing and Github Actions.
- Set up CIGoals
- GoalsBy the end of this step, you will have a CI/CD pipeline for a consumer and provider project. It will run the builds using Github Actions, and use Swagger…
- PrerequisitesGit. You need to know how to git clone, pull, push and commit.
- Fork the repositoriesFork the example-consumer and example-provider projects in to your own Github account (click the 'Fork' button in the top right).
- Test the builds in Github ActionsIn GitHub:
- Configure consumer and provider pipelinesCreate a new production environment to record deployments against
- Configure webhookWhen using Pact in a CI/CD pipeline, there are two reasons for a pact verification task to take place:
- ConclusionYou now have a CI/CD pipeline for your consumer and provider that ensures that each application can deploy safely, and get quick feedback on any…
- Setup Local DevelopmentGoals
- GoalsInstall, run and test the consumer and provider applications in a local development environment.
- PrerequisitesGithub and Swagger Contract Testing set up according to the instructions in the Setup CI page.
- Install dependenciesClone the repositories on to your local machine.
- Run the applicationsStart up the provider API by running npm run start, note the terminal output.
- Run the consumer testsShut down the consumer and provider by pressing ctl+c in each of the terminals.
- Run the provider testsWhen we run the provider verification step on a local development machine, we do not publish the verification results. This is why we only need a read…
- WorkshopGoals
- GoalsTo understand some approaches for implementing new features for an integration following a "consumer driven contracts" process, while ensuring continuous…
- PrerequisitesCI/CD pipelines for the consumer and provider as per the Setup CI/CD page.
- Prerequisite conceptsBefore we start, let's do a brief overview of a couple of key Pact/Pact Broker concepts that you'll need to understand to get the most out of the workshop.
- Protecting provider builds from changed pactsThose familiar with automated testing frameworks have probably come across the term "pending tests". These are tests that have a particular flag on them…
- How not to break everythingWhen we made first made the change to the pact on the master branch of the consumer, we ended up with broken consumer build, stopping them from being…
- Implementing the provider changesThe next step is to implement the changes that have been requested in the pact.
- Strategies for verifying feature pactsWhen a new "feature" pact is created, there are a few ways you could bring that pact into the verification process so that the verification results get…
- Releasing the consumer codeThe provider has now successfully deployed to prod the changes requested by the consumer.
- ConclusionWe have demonstrated how the CI/CD pipelines of the consumer and provider work with Pact and Swagger Contract Testing, and how to introduce and release…
- Consumer-Driven Contract Testing CI/CD (Legacy)Introduction
- Consumer-Driven Contract Testing CI/CD Workshop (Legacy)A workshop demonstrating how to set up a CI/CD pipeline for a consumer and provider using Pact, Swagger Contract Testing and Github Actions.
- Set up CIGoals
- GoalsBy the end of this step, you will have a CI/CD pipeline for a consumer and provider project. It will run the builds using Github Actions, and use Contract…
- PrerequisitesGit. You need to know how to git clone, pull, push and commit.
- Fork the repositoriesFork the example-consumer-legacy and example-provider-legacy projects in to your own Github account (click the 'Fork' button in the top right).
- Test the builds in Github ActionsIn Github:
- Configure consumer and provider pipelinesCreate a new production environment to record deployments against
- Configure webhookWhen using Pact in a CI/CD pipeline, there are two reasons for a pact verification task to take place:
- ConclusionYou now have a CI/CD pipeline for your consumer and provider that ensures that each application can deploy safely, and get quick feedback on any…
- Setup Local DevelopmentGoals
- GoalsInstall, run and test the consumer and provider applications in a local development environment.
- PrerequisitesGitHub and a Swagger account with an active Contract Testing subscription set up according to the instructions in the Setup CI page.
- Install dependenciesClone the repositories on to your local machine.
- Run the applicationsStart up the provider API by running npm run start, note the terminal output.
- Run the consumer testsShut down the consumer and provider by pressing ctl+c in each of the terminals.
- Run the provider testsWhen we run the provider verification step on a local development machine, we do not publish the verification results. This is why we only need a read…
- WorkshopGoals
- GoalsTo understand some approaches for implementing new features for an integration following a "consumer driven contracts" process, while ensuring continuous…
- PrerequisitesCI/CD pipelines for the consumer and provider as per the Setup CI/CD page
- Prerequisite conceptsBefore we start, let's do a brief overview of a couple of key Pact/Pact Broker concepts that you'll need to understand to get the most out of the workshop.
- How to break everythingLet's add a new field to the expectations we have for the product API. We're going to make the change on master, and it's going to break everything. This…
- Protecting provider builds from changed pactsThose familiar with automated testing frameworks have probably come across the term "pending tests". These are tests that have a particular flag on them…
- How not to break everythingWhen we made first made the change to the pact on the master branch of the consumer, we ended up with broken consumer and provider builds, stopping them…
- Implementing the provider changesThe next step is to implement the changes that have been requested in the pact.
- Strategies for verifying feature pactsWhen a new "feature" pact is created, there are a few ways you could bring that pact into the verification process so that the verification results get…
- Releasing the consumer codeThe provider has now successfully deployed to prod the changes requested by the consumer.
- ConclusionWe have demonstrated how the CI/CD pipelines of the consumer and provider work with Pact and Swagger Contract Testing, and how to introduce and release…
- Design First With Swagger StudioQuick Start Guide with Github Actions
- Quick Start Guide with Github ActionsIn this workshop, you will get to see the full development workflow in action. Following the scenario below, we will simplify it for demonstration by…
- Bi-Directional Contract TestingOverview
- Bi-Directional Contract Testing WorkshopLevel: Intermediate
- WorkshopSetting up
- Setting upGit. You need to know how to git clone, pull, push and commit.
- 1. Setting the sceneTo learn the basic concepts of Bi-Directional-Contract-testing, we will work through an example scenario authoring a consumer test between a consumer…
- 2. Create and document an API using OpenAPIAs we are following a specification or design first approach to API development, we start by creating an OpenAPI description document, that describes how…
- 3. Write tests for your ProviderNow that we have our working Provider, we need to do two things to prevent introducing breaking changes to our consumers.
- 4. Publish the provider contract to Swagger Contract TestingNow that we have created and verified our provider contract, we need to share the contract to our consumers. This is where Contract Testing comes into the…
- 5. Deploy the provider to productionNow that we have tested our provider and published our provider contract, we can deploy the application to production.
- 6. Write the API consumerTime to create our consumer code base. For the sake of simplicity, we're going to focus only on the bits of our application that communicate to the…
- 7. Write consumer testsNow is the time to write consumer tests using your mocking tool of choice and convert those mocks into a consumer contract.
- 8. Publish your consumer contract to Swagger Contract TestingNow that we have created our consumer contract, we need to share it to our provider. This is where Contract Testing comes into the picture. This step is…
- 9. Deploy your consumer to ProductionNow that we have tested our consumer and published our consumer contract, we can deploy the application to production.
- 10. Breaking change detectionSo far everything has been really easy. Let's go a bit deeper and introduce a breaking change into the system. Breaking changes come in two main ways:
- 11. ConclusionIf you've made it this far, you should now have a good understanding of how Swagger Contract Testing's bi-directional contract testing feature works to…
- Quick Start Guide with GitHub ActionsYou will get to see a full development workflow in actions, it will follow the scenario below, we will simplify it for demonstration by using GitHub to…
- Advanced PactOverview
- Swagger Contract Testing - Advanced PactUnderstand best practices for write consumer tests
- Organisational ScaleStakeholder buy-in:
- Language TutorialsThese workshops walk you through an example problem from start to finish, exploring the key concepts that Pact supports:
Examples
Drift
- DriftDrift verifies that your API implementation matches the contract that describes it. As APIs evolve, implementation changes and edge cases can cause the…
- TutorialsIn this guide, you will run your first Drift test suite against the live Swagger Petstore API. This requires zero local server setup and demonstrates how…
- Interactive Onboardingdrift init is an interactive terminal UI (TUI) that takes you from zero configuration to a running contract test in a single session. It guides you…
- Managing StateMany APIs require specific system state to test properly. For example, testing "delete product" requires a product to exist first. This tutorial walks you…
- Embedding Drift in Your Test FrameworkIf you already have a test framework (Jest, Playwright, JUnit, pytest, etc.), you can embed Drift as a test case within it. This allows you to:
- Verifying Your First AsyncAPI OperationIn this tutorial you verify that a service publishes an event matching its AsyncAPI contract. You start a local Kafka broker, write a Drift test case, run…
- How-to GuidesThe How-to Guides section provides step-by-step instructions for common Drift workflows, from installation and authentication to writing tests, debugging…
- Installation GuideThis guide covers all installation methods for Drift across different platforms, package managers, and environments.
- Writing Test CasesThe operations section of your Drift test file is where you define individual test scenarios. Each entry describes a specific interaction with your API…
- Async APIDrift verifies message-based APIs described by AsyncAPI 3.x documents, over Kafka, Amazon SNS, and Amazon SQS. This page covers the mechanics common to…
- Using Triggers and ProbesDrift cannot make your service publish a message, and it cannot see inside your service to confirm it consumed one. Triggers and probes are how you supply…
- Testing Asynchronous InteractionsAn asynchronous interaction is fire-and-forget: a message travels one way and there is no reply. Either your service publishes an event, or it consumes a…
- Testing Request/Reply InteractionsA request/reply interaction sends a message and waits for a correlated response on another channel. It is synchronous from your test's point of view, even…
- Generating and Updating Tests with AIUse provider-specific instruction files (custom agents or skills) to generate Drift tests consistently, validate coverage, and maintain tests as your…
- Configuring AuthenticationDrift requires authentication to PactFlow. This is mandatory and separate from authenticating to the target system you're testing.
- Lifecycle HooksLifecycle hooks allow you to execute custom logic at specific stages of the testing process. This is essential for managing provider state, such as…
- Lua ScriptingThis guide introduces Lua basics and shows how to use Lua scripts with Drift. Drift embeds a Lua 5.4 runtime, so you can write small scripts for setup,…
- Working with DatasetsDecouple your test logic from your test data to keep your drift.yaml clean and maintainable.
- Advanced Data ExpressionsDrift provides a powerful expression language to help you inject and manipulate data within your test cases. This allows you to create dynamic tests that…
- Debugging Test CasesWhen a test suite fails, or when you are developing complex new scenarios, running the entire suite can be slow. Drift provides several mechanisms to…
- Parallel Test ExecutionAs your API grows, test suites can become large and slow. Running tests in parallel can significantly reduce execution time in CI/CD pipelines. This guide…
- CI/CD Integration with GitHub ActionsAutomating your Drift test suite within a CI/CD pipeline ensures that your API implementation never deviates from its specification. This guide…
- Publishing Drift Results to PactFlowAfter running Drift tests against your API, you can publish the results to PactFlow. This integrates your provider verification with PactFlow's…
- Managing ComponentsUse drift component to see what is installed, add optional components, keep your installation up to date, and remove components you no longer need. To…
- ConfigurationDrift is flexible: you can configure the engine and its plugins via command-line parameters, environment variables, or configuration files (TOML, YAML,…
- ReferenceThe Reference section provides detailed documentation for configuring, extending, and operating Drift. It includes command references for the CLI, the…
- CLI Command ReferenceThe drift command provides access to the verifier, component manager, authentication, and version-checking commands.
- Drift YAML ReferenceThe drift.yaml file is the primary declarative manifest for your test suite. It is defined as a V1TestCaseDocument and coordinates your sources, plugins,…
- AsyncAPI Execution ModesAn execution mode determines the sequence of steps Drift runs to verify an AsyncAPI operation. Drift selects the mode automatically from the operation…
- Lua Scripting GuideDrift testcases can be extended using Lua 5.4. This allows you to export functions to bind to testcase values or respond to lifecycle events with custom…
- PluginsDrift includes core plugins for OpenAPI and AsyncAPI testing, payload validation, datasets, and reporting. Transport and specialized plugins are optional.…
- OpenAPI (OAS)The OAS plugin is the primary driver for spec-first verification, mapping OpenAPI 3.0/3.1 operations to Drift test cases.
- AsyncAPI PluginThe AsyncAPI plugin loads AsyncAPI documents and exposes their operations as Drift targets. It is the foundational plugin for message-based testing, in…
- Kafka PluginThe Kafka plugin gives Drift the ability to publish to and consume from Apache Kafka topics. It is used alongside the AsyncAPI plugin to verify…
- AWS Messaging Plugin (SNS and SQS)The AWS Messaging plugin gives Drift the ability to publish to Amazon SNS topics and to publish to and consume from Amazon SQS queues. It is used…
- XML PluginThe XML plugin adds support for XML request and response bodies in Drift.
- Form URL Encoded PluginThe form URL encoded plugin adds support for application/x-www-form-urlencoded request bodies in Drift.
- Data PluginThe data plugin allows you to define reusable datasets in YAML format to be injected into your Drift test operations. This promotes clean, data-driven…
- gRPC PluginThe gRPC plugin tests gRPC services against their Protocol Buffers definition. Drift reads your .proto file, exposes every RPC method as a testable…
- MCP pluginThe MCP plugin tests Model Context Protocol servers against a declared MCP definition document. It answers two questions:
- Protobuf PluginThe Protobuf plugin lets Drift encode and validate Protocol Buffers (protobuf) message payloads. Use it with the AsyncAPI plugin to verify message-based…
- Avro PluginThe Avro plugin lets Drift encode and validate Apache Avro message payloads. Use it with the AsyncAPI plugin to verify message-based APIs whose messages…
- ConceptsAPI drift happens when your API's implementation no longer matches its published specification, such as an OpenAPI document.When that mismatch grows over…
- Where Drift FitsThis page explains where Drift fits within a modern API testing strategy. It clarifies Drift’s purpose, how it differs from functional and end‑to‑end…
- Testing Stateful APIs with DriftMany APIs appear to require multiple steps to test. For example:
- Drift ComponentsA Drift installation is made up of components. A component is either an executable, such as drift-verify, or a plugin, such as kafka.plugin, that adds…
- How Drift Verifies Message-Based APIsDrift verifies that a message-based API implementation matches the AsyncAPI document that describes it. This page explains how that verification works,…
Release Notes
On-Premises Admin Guide
- On-Premises Admin GuideOn-Premises 1.x.x Admin Guide
- On-Premises 1.x.x Admin GuideInstallation
- InstallationSwagger Contract Testing On-Premises Architecture
- Swagger Contract Testing On-Premises ArchitectureAn application server capable of running Docker
- System requirementsLinux
- Docker Image RegistryDocker images for our self-hosted Contract Testing On-Premises Enterprise product are hosted at Quay. We will provide Quay.io access for you when signing…
- Network ConfigurationThe Swagger Contract Testing On-Premises application runs on port 9292 by default. This can be configured by setting the PACTFLOW_HTTP_PORT environment…
- Migrating from Pact BrokerIf you have previously used the open source Pact Broker with a PostgreSQL database it is possible to migrate that data to Swagger Contract Testing…
- DatabaseA PostgreSQL database is required for storage of the application data.
- LoggingSwagger Contract Testing On-Premises application logs are sent to the standard output stream of the Docker container, with the expectation that the…
- AuthenticationDemo Auth
- Demo AuthTo allow experimentation with Swagger Contract Testing On-Premises without the need to configure an external identity provider, the "demo" authentication…
- SAMLSwagger Contract Testing On-Premises supports single sign on using the SAML authentication protocol.
- Application configurationEnvironment variables
- Environment variablesThe Swagger Contract Testing On-Premises application log level
- Configuration file templates
- TimezonesThese are the valid values for the TZ environment variable.
- License fileThe Swagger Contract Testing On-Premises version requires a license file to run. You should have received this from us during the onboarding process. If…
- Docker Compose exampleIn this guide, we'll provide an example docker compose setup so that you can see how all of the bits hang together. We will demonstrate:
- Load TestingLoad testing is an important part of installation. It helps to give confidence that the system is setup and configured to scale with the needs of the…
- Installation checklistThe Contract Testing On-Premises version requires a license file to run. You should have received this from us during the onboarding process. If not,…
- UpgradingDatabase migrations
- Database migrationsSchema migrations are run automatically on start-up, unless the PACTFLOW_DATABASE_AUTO_MIGRATE environment variable is set to false. Data migrations are…
- OperationAuthentication
- AuthenticationThe Swagger Contract Testing On-Premises application currently supports single sign for SAML identity providers. It supports both IDP and SP initiated log…
- MaintenanceDatabase
- DatabasePerformance can degrade when too much data accumulates in the Contract Testing On-Premises database. Fortunately, a lot of the data in a Contract Testing…
- SCIMOn-Premises SCIM API
- On-Premises SCIM APIThe Swagger Contract Testing On-Premises SCIM API can be added as a façade to your Contract Testing On-Premises instance. It runs in its own docker…
- Security and supportSecurity audit report
- Security audit reportSwagger Contract Testing On-Premises uses the following tools to ensure the On-Premises image is kept as secure as possible.
- Support policySwagger Contract Testing On-Premises follows a semantic versioning policy for API changes.
- TroubleshootingIt happens to the best of us. Perhaps you're locked out because your only Administrator has left, or maybe you disabled them. Whatever it is, here's how…
- On-Premises 2.x.x Admin GuideInstallation
- InstallationSwagger Contract Testing On-Premises Architecture
- Swagger Contract Testing On-Premises ArchitectureAn application server capable of running Docker.
- System requirementsLinux
- Migrating from Swagger Contract Testing On-Premises 1.xThis major release introduces significant architectural changes and new features:
- Docker Image RegistryWe host Docker images for our self-hosted Contract Testing On-Premises Enterprise product at Quay.
- Network ConfigurationBy default, the Swagger Contract Testing On-Premises application runs on port 9292. To change it, set the PACTFLOW_HTTP_PORT environment variable.
- Migrating from Pact BrokerIf you have previously used the open source Pact Broker with a PostgreSQL database it is possible to migrate that data to Swagger Contract Testing…
- DatabaseA PostgreSQL database is required for storage of the application data.
- CacheSwagger Contract Testing On-Premises requires a storage engine compatible with the Redis Serialization Protocol (RESP) to support the following functions:
- ObservabilitySupported versions: v2.1.0. and later.
- LoggingSwagger Contract Testing On-Premises sends the application logs to the standard output stream of the Docker container, with the expectation that the…
- AuthenticationDemo Auth
- Demo AuthTo allow experimentation with Swagger Contract Testing On-Premises without the need to configure an external identity provider, the "demo" authentication…
- SAMLSwagger Contract Testing On-Premises supports single sign on using the SAML authentication protocol.
- Application configurationEnvironment variables
- Environment variablesThe Swagger Contract Testing On-Premises application log level
- Configuration file templates
- TimezonesThese are the valid values for the TZ environment variable.
- License fileThe Swagger Contract Testing On-Premises on-premises version requires a license file to run. You should have received this from us during the onboarding…
- Docker Compose exampleThis guide provides a sample Docker Compose setup to illustrate how the components work together. It demonstrates:
- Load TestingLoad testing is an important part of installation. It helps to give confidence that the system is setup and configured to scale with the needs of the…
- Installation checklistFollow the checklist to ensure that you have set up Swagger Contract Testing On-Premises properly.
- UpgradingDatabase migrations
- Database migrationsSchema migrations are run automatically on start-up, unless the PACTFLOW_DATABASE_AUTO_MIGRATE environment variable is set to false. Data migrations are…
- OperationAuthentication
- AuthenticationThe Swagger Contract Testing On-Premises application currently supports single sign for SAML identity providers. It supports both IDP and SP initiated log…
- MaintenanceDatabase
- DatabasePerformance can degrade when too much data accumulates in the Contract Testing On-Premises database. Fortunately, a lot of the data in a Contract Testing…
- SCIMOn-Premises SCIM API
- On-Premises SCIM APIThe Swagger Contract Testing On-Premises SCIM API can be added as a surface to your Contract Testing On-Premises instance. It runs in its own docker…
- Security and supportSecurity audit report
- Security audit reportSwagger Contract Testing On-Premises uses the following tools to ensure the On-Premises image is kept as secure as possible.
- Support policySwagger Contract Testing On-Premises follows a semantic versioning policy for API changes.
- TroubleshootingIt happens to the best of us. Perhaps you're locked out because your only Administrator has left, or maybe you disabled them. Whatever it is, here's how…
- On-Premises Release NotesMarch 26, 2026
- 2.6.1August 6, 2026
- 2.6.0July 22, 2026
- 2.5.2March 7, 2026
- 2.5.1March 12, 2026
- 2.5.0February 11, 2026
- 2.4.0December 17, 2025
- 2.3.0October 21, 2025
- 2.2.0August 19, 2025
- 2.1.1July 17, 2025
- 2.1.0July 10, 2025
- 2.0.0June 27, 2025
- 1.37.6March 26, 2026
- 1.37.5March 12, 2026
- 1.37.4February 11, 2026
- 1.37.3December 17, 2025
- 1.37.2August 19, 2025
- 1.37.1July 17, 2025
- 1.37.0July 11, 2025
- 1.36.017 January 2025
- 1.35.018 November 2024
- 1.34.022 October 2024
- 1.33.018 September 2024
- 1.32.09 September 2024
- 1.31.022 August 2024
- 1.30.010 April 2024
- 1.29.031 January 2024
- 1.28.028 November 2023
- 1.27.021 September 2023
- 1.26.007 August 2023
- 1.25.028 June 2023
- 1.24.06 June 2023
- 1.23.122 May 2023
- 1.23.023 Feb 2023
- 1.22.123 Feb 2023
- 1.22.013 Feb 2023
- 1.21.14 Nov 2022
- 1.21.021 October 2022
- 1.20.02 September 2022
- 1.19.224 August 2022
- 1.19.118 August 2022
- 1.19.01 August 2022
- 1.18.031 May 2022
- 1.17.312 April 2022
- 1.17.228 March 2022
- 1.17.110 March 2022
- 1.17.025 February 2022
- 1.16.018 February 2022
- 1.15.015 February 2022
- 1.14.811 February 2022
- 1.14.711 February 2022
- 1.14.610 February 2022
- 1.14.57 February 2022
- 1.14.43 February 2022
- 1.14.31 February 2022
- 1.14.231 January 2022
- 1.14.17 December 2021
- 1.14.02 December 2021
- 1.13.127 September 2021
- 1.13.023 September 2021
- 1.12.021 September 2021
- 1.11.19 July 2021
- 1.11.05 July 2021
- 1.10.031 March 2021
- 1.9.01 February 2021
- 1.8.018 December 2020
- 1.7.08 December 2020
- 1.6.1Remove unused vulnerable version of Bundler from base Docker image.
- 1.6.0Add all new users and applications to a Default team.
- 1.5.0Allow users and applications to be assigned to teams.
- 1.4.1Fixed the users screen to not overflow text with long email addresses.
- 1.4.0Provide an API stub for every pact.