Specmatic for Visual Studio Code

Specmatic VSCode Extension brings the power of Specmatic to your favourite editor. This extension provides a rich interactive UI to make developer experience for Contract Driven Development even more seamless. It allows developers to run contract tests from within VSCode and update API specifications with examples that will act as test data.

Features

Run contract tests

Interactive UI to select your OpenAPI specifications, provide a target URL where you application is running and run the tests. The extension will take care of all the configurations for you and it will remember your previous run settings.

Add Examples / Test Data to your OpenAPI specification

Specmatic's GPT uses AI to automatically create named examples in your OpenAPI specifications which you can then leverage as test data.

Usage

• Run contract tests: Select Specmatic: Run Contract Test in you command palette and follow the instructions in the UI
• Add Examples / Test Data to your OpenAPI specification: Open the OpenAPI specification that you wish to add examples to, launch command palette and select Specmatic: Generate Examples. Follow the instructions to see the examples in diff view. Use the examples as is or fine tune them and run contract test with Specmatic: Run contract tests.

If you have suggestions for how Specmatic could be improved, or want to report bugs, please open an issue here.

Powered by OpenAI

Specmatic extension uses GPT4 under the hood to make your experience of adding examples to your OpenAPI specifications effortless. Our extension operates by sending your spec from your active editor to OpenAI's APIs via our backend over secure HTTPS connections to generate relevant examples, which are integrated back into your spec file within VSCode.