Configuration
Specmatic uses a configuration file to manage API specifications, test settings, stub configurations, and more. This section provides comprehensive guidance on configuring Specmatic for your needs.
Note: Version 2 is the latest as of 14/02/2025. If you are using an older version, see the Upgrade Configuration guide to migrate.
Configuration Topics
- Getting Started - Basic setup and configuration upgrade
- Contract Management - Managing contracts from Git or filesystem
- Test Configuration - Contract testing settings
- Mock Configuration - Mock settings
- Reports - Report generation and formatters
- Hooks - Custom commands and integrations
- Template Values - Environment-driven configuration values
- Complete Examples - Full configuration examples
- Upgrade Configuration - Upgrading older configuration files
Quick Start
We often have to pass more than one API Specification file to Specmatic to stub or test. While it is possible to send all the files as command line options, there is a better way.
Also, if your contracts are stored in a source control system like Git, we need to provide details about the repository so that Specmatic can pull your specifications directly from your version control.
See the Getting Started guide for detailed setup instructions.