specmatic/specmatic

Specmatic

![Maven Central]([] !https://github.com/specmatic/specmatic/workflows/CI%20Build/badge.svg ![Quality Gate Status]([] ![*** Follow]([***]

无需编码，几秒钟内将API规范转换为可执行契约

体验契约驱动开发的强大能力，自信地开发并独立部署微服务和微前端，加速开发流程。

镜像概述和主要用途

Specmatic是一个支持契约驱动开发的工具，通过将OpenAPI、AsyncAPI、GraphQL SDL、gRPC Proto等API规范转换为可执行契约，帮助团队在复杂依赖生态中明确服务间依赖关系，实现即时反馈，避免意外破坏，支持独立部署，减少对昂贵且脆弱的集成测试的依赖。

核心功能和特性

• 契约测试：基于API规范对服务进行自动化契约测试
• 服务虚拟化：根据API规范启动存根服务器，模拟服务响应
• 向后兼容性测试：检查API规范变更是否保持向后兼容
• 示例验证：验证API规范中内联示例的有效性
• 多规范支持：兼容OpenAPI、AsyncAPI、GraphQL、gRPC等多种API规范

使用场景和适用范围

• 微服务架构下的服务间依赖管理
• 快速演进的复杂系统中确保API兼容性
• 独立团队并行开发时的契约协作
• 减少集成测试成本，提升部署信心
• API规范的质量验证和示例校验

使用方法和配置说明

1. 运行Specmatic契约测试

shell
docker run -v "$(pwd)/openapi.yaml:/openapi.yaml" specmatic/specmatic test "/openapi.yaml" --testBaseURL=http://localhost:8080

说明：使用当前目录下的openapi.yaml文件，对运行在http://localhost:8080的服务执行契约测试。

2. 运行Specmatic服务虚拟化

shell
docker run -v "$(pwd)/openapi.yaml:/openapi.yaml" -p "9000:9000"  specmatic/specmatic virtualize "/openapi.yaml"

说明：基于openapi.yaml文件在本地9000端口启动存根服务器，根据规范中的示例响应API请求。

3. 运行Specmatic向后兼容性测试

shell
docker run -v "$(pwd):/repo:rw" --user $(id -u):$(id -g) specmatic/specmatic backward-compatibility-check --repo-dir=/repo --base-branch=origin/main

说明：对比当前目录中的API规范文件与origin/main分支上的规范，执行向后兼容性检查。

4. 运行Specmatic示例验证

shell
docker run -v "./openapi.yaml:/openapi.yaml" specmatic/specmatic examples validate --spec-file="/openapi.yaml" --examples-to-validate=INLINE

说明：验证openapi.yaml文件中内联示例的有效性。

5. 查看完整命令列表

shell
docker run specmatic/specmatic --help

示例项目

https://github.com/specmatic/specmatic-order-bff-java?tab=readme-ov-file#break-down-each-component-to-understand-what-is-happening

背景

在复杂、相互依赖的生态系统中，每个服务都在快速演进，我们希望以可执行契约的形式明确服务间的依赖关系。契约驱动开发利用OpenAPI、AsyncAPI、GraphQL SDL、gRPC Proto等API规范作为可执行契约，使团队在进行变更时获得即时反馈，避免意外破坏。

借助这一能力，我们现在可以随时独立部署任何服务，而无需依赖昂贵且脆弱的集成测试。

了解更多请访问 specmatic.io 🌐

![Specmatic - 契约驱动开发]([***]

***播放列表 📺

更多详情请参考 Specmatic文档