https://github.com/specmatic/studio-demo
Demo project showcasing how to use Specmatic Studio for API contract testing, mocking, resiliency, and more, with hands-on video guidance.
https://github.com/specmatic/studio-demo
api-mock api-testing contract-testing microservices openapi
Last synced: 7 months ago
JSON representation
Demo project showcasing how to use Specmatic Studio for API contract testing, mocking, resiliency, and more, with hands-on video guidance.
- Host: GitHub
- URL: https://github.com/specmatic/studio-demo
- Owner: specmatic
- Created: 2025-06-16T18:48:59.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-07-19T11:46:24.000Z (7 months ago)
- Last Synced: 2025-07-19T16:14:05.460Z (7 months ago)
- Topics: api-mock, api-testing, contract-testing, microservices, openapi
- Homepage: https://specmatic.io/specmatic-studio/
- Size: 699 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Specmatic Studio Demo 🚀
[Specmatic Studio](https://specmatic.io/specmatic-studio/) is a **#NOCODE** GUI interface that simplifies:
- API Contract Testing 🤝
- API Mocking 🧪
- API Resiliency Testing 🛡️
- Backward Compatibility Testing 🔄
- API Spec Generation 📄
- ...and more!
---
This demo project showcases how to contract test a [Backend For Frontend (BFF) Service / API](https://github.com/specmatic/specmatic-order-bff-java). We will also demonstrate how to isolate this BFF service from its dependencies—a HTTP [Domain Service / API](https://github.com/specmatic/specmatic-order-api-java) and another asynchronous service listening on Kafka—using API mocking. In the process, we will explore the ability to record API specifications using Specmatic Proxy and perform Backward Compatibility Testing as we make changes to API specifications.
## 🎬 Video Walkthrough
[](https://www.youtube.com/watch?v=pdy6Z1BXbV0)
Watch the demo video above or directly on [YouTube](https://www.youtube.com/watch?v=pdy6Z1BXbV0). This video uses this very same repo to demonstrate the features described below. You can also use this repo to follow along with the video and learn about the various capabilities.
---
## 🏗️ Application Architecture and Test Setup
---
## 🛠️ Prerequisites
- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
---
## 🚦 Usage
### 1️⃣ Setup
1. **Clone the repository:**
```shell
git clone https://github.com/specmatic/studio-demo
```
2. **Navigate to the project directory:**
```shell
cd studio-demo
```
3. **Start Studio along with the required App services:**
```shell
docker compose up
```
These steps will bring up the following services in addition to Specmatic Studio itself:
- Order BFF Service / API
- Order Domain Service / API
---
### 2️⃣ Getting Familiar with the Studio Interface
Open [Specmatic Studio](http://localhost:9000/_specmatic/studio) in your browser:
```shell
open http://localhost:9000/_specmatic/studio
```
---
### 3️⃣ Exploring API Specifications
Click on the hamburger icon on the left-hand side of the screen to reveal the API Spec browser. This demo setup is already preloaded with two API specifications:
1. An OpenAPI spec ([product_search_bff_v3.yaml](specs/product_search_bff_v3.yaml)) that describes the API exposed by the Order BFF service
2. An AsyncAPI spec ([kafka.yaml](specs/kafka.yaml)) that describes the API interface of the Kafka that the BFF service depends on
---
### 4️⃣ Getting Started with API Contract Testing and API Mocking
Since we need a Kafka broker running for the BFF, let's start a Specmatic KafkaMock using the AsyncAPI specification mentioned above. When you click on the file `kafka.yaml`, a screen will appear allowing you to start the Mock.
Now, you can jump right into running Contract Tests on the BFF service using the OpenAPI specification:
1. Click on the OpenAPI spec `product_search_bff_v3` to see an API overview.
2. At the top, you will see a `TEST` button.
3. Enter the BFF service URL as `http://order-bff:8080` (since the Order BFF service is running within Docker, we use the container name instead of localhost) and run the test.
You will now see the test report appear, and you can click on the details to drill down into the test results:
- Review the request and response
- Observe how the test name is based on the operations
---
🎉 **Congratulations!** You have successfully run an API Contract Test completely based on the OpenAPI spec without writing a single line of code.
---
Excited to learn more about what you can do? 🚀
- Record API specifications using the Proxy
- Simulate faults using the Mock server
- Generate spec-accurate examples to use as test and stub data
- Make sure API spec changes are backward compatible
- ...and much more!
👉 [Follow along with the video walkthrough above.](#-video-walkthrough)