API契约测试指南：Pact与OpenAPI实践，保障微服务接口一致性
api-contract-testing by secondsky/claude-skills
安装命令
npx skills add https://github.com/secondsky/claude-skills --skill api-contract-testing🇨🇳中文介绍
API 契约测试
验证 API 是否遵守消费者与提供者之间的契约，而无需进行完整的集成测试。
核心概念
| 术语 | 定义 |
|---|---|
| 消费者 | 调用 API 的服务 |
| 提供者 | 暴露 API 的服务 |
| 契约 | 约定的请求/响应格式 |
| Pact | 消费者驱动的契约测试工具 |
| Schema | 结构定义（OpenAPI、JSON Schema） |
| Broker | 契约的中央存储库 |
Pact 消费者测试 (TypeScript)
import { PactV3, MatchersV3 } from '@pact-foundation/pact';
const provider = new PactV3({
consumer: 'OrderService',
provider: 'UserService'
});
describe('User API Contract', () => {
it('returns user by ID', async () => {
await provider
.given('user 123 exists')
.uponReceiving('a request for user 123')
.withRequest({ method: 'GET', path: '/users/123' })
.willRespondWith({
status: 200,
body: MatchersV3.like({
id: '123',
name: MatchersV3.string('John'),
email: MatchersV3.email('john@example.com')
})
})
.executeTest(async (mockServer) => {
const response = await fetch(`${mockServer.url}/users/123`);
expect(response.status).toBe(200);
});
});
it('returns 404 for non-existent user', async () => {
await provider
.given('user does not exist')
.uponReceiving('a request for non-existent user')
.withRequest({ method: 'GET', path: '/users/999' })
.willRespondWith({
status: 404,
body: MatchersV3.like({
error: { code: 'NOT_FOUND', message: MatchersV3.string() }
})
})
.executeTest(async (mockServer) => {
const response = await fetch(`${mockServer.url}/users/999`);
expect(response.status).toBe(404);
});
});
});
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者，精准高效
