К основному содержанию
скилл CX Codex

api-contract-testing — скилл для Claude Code: обзор и установка

Скилл настраивает проверку контрактов API между сервисами без запуска полных интеграционных тестов. Помогает избежать несовместимых правок в CI.

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add aj-geddes/useful-ai-prompts --skill api-contract-testing -a claude-code
Открыть на GitHub

Что делает api-contract-testing

Скилл ориентирован на проверку взаимодействия consumer-provider в микросервисах. Он помогает описывать и проверять форматы запросов и типы данных независимо от всей остальной системы.

Внутри собраны практические руководства по Pact, валидации схем OpenAPI и JSON Schema, работе с REST Assured для Java и тестам в Postman. Отдельный блок охватывает интеграцию с Pact Broker для публикации и совместного использования контрактов.

В контрактных тестах нельзя проверять бизнес-логику или жёстко фиксировать конкретные значения данных: фокус идёт на проверку структуры схем через матчеры. Это убережёт команду от падений в CI из-за мелких изменений в полезной нагрузке.

Какие задачи решает

  • проверить форматы запросов и ответов между микросервисами
  • предотвратить ломающие изменения в схемах OpenAPI и Swagger
  • настроить публикацию контрактов через Pact Broker
  • валидировать обратную совместимость API при сборке в CI

Примеры запросов агенту

  • напиши контрактный тест на Pact для OrderService и UserService
  • настрой валидацию OpenAPI схемы для эндпоинта /users/{id}
  • добавь проверку обратной совместимости контракта в CI пайплайн

Как установить api-contract-testing

1Через Skills CLI (Vercel)

npx skills add aj-geddes/useful-ai-prompts --skill api-contract-testing -a claude-code

2Вручную: положить файлы

~/.claude/skills/api-contract-testing/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/api-contract-testing/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о api-contract-testing

Как установить api-contract-testing в Claude Code?

Выполните команду npx skills add aj-geddes/useful-ai-prompts --skill api-contract-testing -a claude-code.

Зачем нужен скилл api-contract-testing?

Он даёт шаблоны и правила для проверки контрактов между сервисами-потребителями и провайдерами без необходимости запускать тяжёлые интеграционные тесты.

Какие инструменты и библиотеки поддерживаются в руководствах скилла?

Материалы включают примеры для Pact с Pact Broker, валидацию через OpenAPI и JSON Schema, а также связки с REST Assured для Java и Postman.

Исходный текст

SKILL.md · MIT
---
name: api-contract-testing
description: >
  Verify API contracts between services to ensure compatibility and prevent
  breaking changes. Use for contract testing, Pact, API contract validation,
  schema validation, and consumer-driven contracts.
---

# API Contract Testing

## Table of Contents

- [Overview](#overview)
- [When to Use](#when-to-use)
- [Quick Start](#quick-start)
- [Reference Guides](#reference-guides)
- [Best Practices](#best-practices)

## Overview

Contract testing verifies that APIs honor their contracts between consumers and providers. It ensures that service changes don't break dependent consumers without requiring full integration tests. Contract tests validate request/response formats, data types, and API behavior independently.

## When to Use

- Testing microservices communication
- Preventing breaking API changes
- Validating API versioning
- Testing consumer-provider contracts
- Ensuring backward compatibility
- Validating OpenAPI/Swagger specifications
- Testing third-party API integrations
- Catching contract violations in CI

## Quick Start

Minimal working example:

```typescript
// tests/pact/user-service.pact.test.ts
import { PactV3, MatchersV3 } from "@pact-foundation/pact";
import { UserService } from "../../src/services/UserService";

const { like, eachLike, iso8601DateTimeWithMillis } = MatchersV3;

const provider = new PactV3({
  consumer: "OrderService",
  provider: "UserService",
  port: 1234,
  dir: "./pacts",
});

describe("User Service Contract", () => {
  const userService = new UserService("http://localhost:1234");

  describe("GET /users/:id", () => {
    test("returns user when found", async () => {
      await provider
        .given("user with ID 123 exists")
        .uponReceiving("a request for user 123")
        .withRequest({
          method: "GET",
          path: "/users/123",
          headers: {
// ... (see reference guides for full implementation)
```

## Reference Guides

Detailed implementations in the `references/` directory:

| Guide | Contents |
|---|---|
| [Pact for Consumer-Driven Contracts](references/pact-for-consumer-driven-contracts.md) | Pact for Consumer-Driven Contracts |
| [OpenAPI Schema Validation](references/openapi-schema-validation.md) | OpenAPI Schema Validation |
| [JSON Schema Validation](references/json-schema-validation.md) | JSON Schema Validation |
| [REST Assured for Java](references/rest-assured-for-java.md) | REST Assured for Java |
| [Contract Testing with Postman](references/contract-testing-with-postman.md) | Contract Testing with Postman |
| [Pact Broker Integration](references/pact-broker-integration.md) | Pact Broker Integration |

## Best Practices

### ✅ DO

- Test contracts from consumer perspective
- Use matchers for flexible matching
- Validate schema structure, not specific values
- Version your contracts
- Test error responses
- Use Pact broker for contract sharing
- Run contract tests in CI
- Test backward compatibility

### ❌ DON'T

- Test business logic in contract tests
- Hard-code specific values in contracts
- Skip error scenarios
- Test UI in contract tests
- Ignore contract versioning
- Deploy without contract verification
- Test implementation details
- Mock contract tests

© aj-geddes · MIT · aj-geddes/useful-ai-prompts

Похожие скиллы

Всё по теме «Тесты и QA» →
contract-testing kindlmann Скилл для потребительских контрактных тестов на Pact-JS: пишет тесты консьюмера, проверяет провайдера и ставит гейт на деплой. CX Codex +1 1 100установок api-testing-patterns proffesor-for-testing Скилл с готовыми паттернами тестирования REST и GraphQL API: контракты, авторизация, идемпотентность, гонки. Пригодится, когда пишете тесты или выбираете стратегию. CX Codex +1 605установок api-testing-observability Seth Hobson Плагин закрывает рутину вокруг API: автотесты, моки запросов, генерация OpenAPI-документации и настройка наблюдаемости. CX Codex ★ 41 729звёзд репо java-testing-advanced pluginagentmarketplace Скилл для продвинутого тестирования Java: поднимает реальные базы и Kafka в контейнерах, проверяет контракты API, ищет дыры в покрытии мутациями. CX Codex +1 328установок api-testing-observability-api-documenter Seth Hobson Субагент пишет документацию API: спецификации OpenAPI 3.1, интерактивные примеры, SDK и порталы для разработчиков. Пригодится, когда API есть, а описания к нему нет. CX Codex ★ 41 729звёзд репо api-reference-quality Samuel Berthe Аудирует справочник API по спецификации OpenAPI и находит расхождения в эндпоинтах, кодах ошибок и примерах. Помогает внедрить проверки в CI. CX Codex +1 7 800установок

Из того же набора118

terraform-infrastructure Направляет агента при настройке облачной инфраструктуры через Terraform с модулями и удалённым стейтом. Пригодится для выката окружений dev, staging и prod. CX Codex +1 1 200установок penetration-testing Скилл помогает модели планировать и проводить этичное тестирование безопасности, симулируя атаки на приложения и сетевую инфраструктуру. CX Codex +1 1 100установок responsive-web-design Скилл для ИИ-агента, который помогает писать адаптивные интерфейсы на Flexbox, CSS Grid и медиазапросах. Пригодится, когда вёрстка должна работать на телефоне и десктопе. CX Codex +1 1 100установок css-architecture Скилл для ИИ-агента, который помогает разложить CSS по методологиям BEM, SMACSS и CSS-in-JS. Пригодится, когда стили в проекте растут быстрее, чем вы успеваете их переименовывать. CX Codex +1 959установок event-sourcing Скилл для ИИ-агента, который помогает проектировать event sourcing и CQRS: хранилище событий, агрегаты, проекции и снапшоты. Пригодится, когда нужна история изменений и запросы к состоянию на любой момент. CX Codex +1 886установок root-cause-analysis Скилл ведёт разбор инцидента по шагам и доводит до причины, которую можно устранить, а не залатать симптом. CX Codex +1 884установок mobile-first-design Скилл задаёт порядок работы над интерфейсом: сначала мобильный экран, потом планшет и десктоп. Пригодится, когда вёрстка разъезжается на телефонах. CX Codex +1 857установок mobile-app-testing Задаёт правила тестирования приложений для iOS и Android. Помогает писать юнит-, UI- и интеграционные тесты с Jest, Detox, Espresso и XCTest. CX Codex +1 823установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой