Skip to main content
Support
Manage case
Open a case
Swagger
Documentation
Documentation
Studio
Portal
Contract Testing
Explore
Test
Swagger Catalog
Studio On-Premise
Protocol Support
Community
(opens in a new tab)
Online Learning
(opens in a new tab)
Documentation
Studio
Portal
Contract Testing
Explore
Test
Swagger Catalog
Studio On-Premise
Protocol Support
Community
Online Learning
Manage case
Open a case
Swagger
Contract Testing
1.14.5
All documentation pages
+
−
User Guide
Getting Started with Swagger Contract Testing
+
−
User Interface
+
−
User Interface 1.x.x (On-Premises)
Dashboard
Bi-Directional Contract Testing
Can I Deploy
+
−
Settings
API Tokens
Preferences
Webhooks
Secrets
Users
Environments
Teams
+
−
User Interface 2.x.x
Dashboard
Application
Integration
Contract Details
Bi-Directional Contract Testing
+
−
Settings
API Tokens
Preferences
Webhooks
Secrets
Users
System Accounts
Teams
Roles
Environments
+
−
Features
+
−
AI
Test Generation featuring AI
Quick Start
Using AI
Managing AI
AI Skills
Troubleshooting
Further Learning
Stubs
+
−
Roles and permissions
Role-Based Access Control
Predefined roles
Permissions
API token permissions
Authentication
+
−
Contract Testing
Pact
+
−
Bi-Directional Contract Testing
Bi-Directional Contract Testing Guide
Consumer Testing Guide
Provider Testing Guide
Publishing Contracts
Compatibility Checks (breaking change detection)
Deploying and Releasing
+
−
Supported Contracts
Pact Contracts
+
−
OpenAPI Specification
OpenAPI Specification Contracts
Features
Keyword Support
Configuration
Changelog
+
−
AsyncAPI Specification
AsyncAPI Contracts - Overview
Features - Testing AsyncAPI
Avro Payloads
Protobuf Payloads
+
−
Tool Integration
Tools
Tooling integration - Swagger Studio
Tooling integration - Cypress
Tooling integration - MSW
Tooling integration - Wiremock
Tooling integration - Wiremock
+
−
Integrations
Swagger Studio Integration
+
−
Troubleshooting
Glossary
Authorization Errors
Webhooks / Public IPs
PowerShell Migration guide
Disabling dangerous contract modification
Slow responses when fetching pacts for verification
+
−
Migration from PactFlow to Swagger Contract Testing
Migration FAQ
API
+
−
Swagger Contract Testing University
Swagger Contract Testing University
Tutorials
+
−
Introduction to Pact
Swagger Contract Testing - Introduction to Pact
Learning Outcomes
Further Reading
+
−
Consumer-Driven Contract Testing CI/CD
Consumer-Driven Contract Testing CI/CD Workshop
+
−
Set up CI
Goals
Prerequisites
Fork the repositories
Test the builds in Github Actions
Configure consumer and provider pipelines
Configure webhook
Conclusion
+
−
Setup Local Development
Goals
Prerequisites
Install dependencies
Run the applications
Run the consumer tests
Run the provider tests
+
−
Workshop
Goals
Prerequisites
Prerequisite concepts
Protecting provider builds from changed pacts
How not to break everything
Implementing the provider changes
Strategies for verifying feature pacts
Releasing the consumer code
Conclusion
+
−
Consumer-Driven Contract Testing CI/CD (Legacy)
Consumer-Driven Contract Testing CI/CD Workshop (Legacy)
+
−
Set up CI
Goals
Prerequisites
Fork the repositories
Test the builds in Github Actions
Configure consumer and provider pipelines
Configure webhook
Conclusion
+
−
Setup Local Development
Goals
Prerequisites
Install dependencies
Run the applications
Run the consumer tests
Run the provider tests
+
−
Workshop
Goals
Prerequisites
Prerequisite concepts
How to break everything
Protecting provider builds from changed pacts
How not to break everything
Implementing the provider changes
Strategies for verifying feature pacts
Releasing the consumer code
Conclusion
+
−
Design First With Swagger Studio
Quick Start Guide with Github Actions
+
−
Bi-Directional Contract Testing
Bi-Directional Contract Testing Workshop
+
−
Workshop
Setting up
1. Setting the scene
2. Create and document an API using OpenAPI
3. Write tests for your Provider
4. Publish the provider contract to Swagger Contract Testing
5. Deploy the provider to production
6. Write the API consumer
7. Write consumer tests
8. Publish your consumer contract to Swagger Contract Testing
9. Deploy your consumer to Production
10. Breaking change detection
11. Conclusion
Quick Start Guide with GitHub Actions
+
−
Advanced Pact
Swagger Contract Testing - Advanced Pact
Organisational Scale
Language Tutorials
Examples
+
−
Drift
+
−
Tutorials
Interactive Onboarding
Managing State
Embedding Drift in Your Test Framework
Verifying Your First AsyncAPI Operation
+
−
How-to Guides
Installation Guide
Writing Test Cases
+
−
Async API
Using Triggers and Probes
Testing Asynchronous Interactions
Testing Request/Reply Interactions
Generating and Updating Tests with AI
Configuring Authentication
Lifecycle Hooks
Lua Scripting
Working with Datasets
Advanced Data Expressions
Debugging Test Cases
Parallel Test Execution
CI/CD Integration with GitHub Actions
Publishing Drift Results to PactFlow
Managing Components
Configuration
+
−
Reference
CLI Command Reference
Drift YAML Reference
AsyncAPI Execution Modes
Lua Scripting Guide
+
−
Plugins
OpenAPI (OAS)
AsyncAPI Plugin
Kafka Plugin
AWS Messaging Plugin (SNS and SQS)
XML Plugin
Form URL Encoded Plugin
Data Plugin
gRPC Plugin
MCP plugin
Protobuf Plugin
Avro Plugin
+
−
Concepts
Where Drift Fits
Testing Stateful APIs with Drift
Drift Components
How Drift Verifies Message-Based APIs
Release Notes
+
−
On-Premises Admin Guide
+
−
On-Premises 1.x.x Admin Guide
+
−
Installation
Swagger Contract Testing On-Premises Architecture
System requirements
Docker Image Registry
Network Configuration
Migrating from Pact Broker
Database
Logging
+
−
Authentication
Demo Auth
SAML
+
−
Application configuration
Environment variables
Configuration file templates
Timezones
License file
Docker Compose example
Load Testing
Installation checklist
+
−
Upgrading
Database migrations
+
−
Operation
Authentication
+
−
Maintenance
Database
+
−
SCIM
On-Premises SCIM API
+
−
Security and support
Security audit report
Support policy
Troubleshooting
+
−
On-Premises 2.x.x Admin Guide
+
−
Installation
Swagger Contract Testing On-Premises Architecture
System requirements
Migrating from Swagger Contract Testing On-Premises 1.x
Docker Image Registry
Network Configuration
Migrating from Pact Broker
Database
Cache
Observability
Logging
+
−
Authentication
Demo Auth
SAML
+
−
Application configuration
Environment variables
Configuration file templates
Timezones
License file
Docker Compose example
Load Testing
Installation checklist
+
−
Upgrading
Database migrations
+
−
Operation
Authentication
+
−
Maintenance
Database
+
−
SCIM
On-Premises SCIM API
+
−
Security and support
Security audit report
Support policy
Troubleshooting
+
−
On-Premises Release Notes
2.6.1
2.6.0
2.5.2
2.5.1
2.5.0
2.4.0
2.3.0
2.2.0
2.1.1
2.1.0
2.0.0
1.37.6
1.37.5
1.37.4
1.37.3
1.37.2
1.37.1
1.37.0
1.36.0
1.35.0
1.34.0
1.33.0
1.32.0
1.31.0
1.30.0
1.29.0
1.28.0
1.27.0
1.26.0
1.25.0
1.24.0
1.23.1
1.23.0
1.22.1
1.22.0
1.21.1
1.21.0
1.20.0
1.19.2
1.19.1
1.19.0
1.18.0
1.17.3
1.17.2
1.17.1
1.17.0
1.16.0
1.15.0
1.14.8
1.14.7
1.14.6
1.14.5
1.14.4
1.14.3
1.14.2
1.14.1
1.14.0
1.13.1
1.13.0
1.12.0
1.11.1
1.11.0
1.10.0
1.9.0
1.8.0
1.7.0
1.6.1
1.6.0
1.5.0
1.4.1
1.4.0
1.14.5
Release date
7 February 2022
Fixes
Fix CVE-2021-3918
Migration notes
N/A
Was this page helpful?
Yes
No
Thanks for the feedback.
Still stuck? Open a case
Previous
1.14.6
Next
1.14.4