Examples

Explore practical examples of using amqp-contract.

Architecture Overview

The amqp-contract library enables type-safe AMQP messaging with three main components:

Available Examples

Basic Order Processing

A complete example demonstrating:

• Contract definition
• Type-safe publishing
• Type-safe consuming
• Multiple consumers (pub/sub pattern)

Technologies:

• RabbitMQ
• TypeScript
• Zod schemas

AsyncAPI Generation

Learn how to generate AsyncAPI 3.0 specifications:

• Generate from contracts
• Server configurations
• Documentation generation

Technologies:

• AsyncAPI 3.0
• JSON/YAML output
• Documentation tooling

Running Examples

All examples are located in the samples/ directory of the repository.

Prerequisites

1. RabbitMQ running on localhost:5672

docker run -d --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:4-management

2. Build the packages

pnpm build

Run an Example

The basic order processing example is split into three packages:

# Terminal 1: Start the worker
pnpm --filter @amqp-contract-samples/basic-order-processing-worker dev

# Terminal 2: Run the client
pnpm --filter @amqp-contract-samples/basic-order-processing-client dev

Example Structure

The basic order processing example is structured as three separate packages for better separation of concerns:

samples/
├── basic-order-processing-contract/
│   ├── src/
│   │   └── index.ts       # Shared contract definition
│   ├── package.json
│   └── README.md
├── basic-order-processing-client/
│   ├── src/
│   │   └── index.ts       # Message publisher
│   ├── package.json
│   └── README.md
└── basic-order-processing-worker/
    ├── src/
    │   └── index.ts       # Message consumer
    ├── package.json
    └── README.md

Next Steps

• Try the Basic Order Processing example
• Generate AsyncAPI specifications
• Read the Getting Started guide