redis-smq-rest-api

RedisSMQ REST API

RedisSMQ REST API provides an HTTP interface enabling any web-capable application to interact with the RedisSMQ message queue using a RESTful API.

Features

• 🚀 Clean and efficient implementation
• ✅ Strict request/response validation using JSON Schema
• 📚 Native OpenAPI v3 support and Swagger UI
• 🧪 90%+ code coverage with extensive testing
• 📦 Support for both ESM & CJS modules

Prerequisites

• RedisSMQ V8 latest release.

Installation

# Using npm
npm install redis-smq-rest-api --save

# Using yarn
yarn add redis-smq-rest-api

# Using pnpm
pnpm add redis-smq-rest-api

Version Compatibility

⚠️ Important: Always install matching versions of RedisSMQ packages to ensure compatibility.

npm install redis-smq@x.x.x redis-smq-rest-api@x.x.x redis-smq-common@x.x.x

See version compatibility for details.

Configuration

The REST API configuration extends the base RedisSMQ configuration with additional API server settings.

Configuration Options

export type THttpApiConfig = {
  port?: number;
  host?: string;
  basePath?: string;
};

export interface IRedisSMQHttpApiConfig extends IRedisSMQConfig {
  apiServer?: THttpApiConfig;
}

Configuration Examples

import { RedisSmqRestApi } from 'redis-smq-rest-api';

// Basic configuration
const basicConfig: IRedisSMQHttpApiConfig = {
  redis: {
    client: 'ioredis',
    options: {
      host: '127.0.0.1',
      port: 6379,
    },
  },
  apiServer: {
    host: '127.0.0.1',
    port: 7210,
  },
};

Usage

import { RedisSmqRestApi } from 'redis-smq-rest-api';

const config: IRedisSMQHttpApiConfig = {
  redis: {
    client: ERedisConfigClient.IOREDIS,
    options: {
      host: '127.0.0.1',
      port: 6379,
    },
  },
  apiServer: {
    host: '127.0.0.1',
    port: 7210,
  },
};

const apiServer = new RedisSmqRestApi(config);
apiServer.run();

API Documentation

Swagger UI

Access the interactive API documentation at:

http://<HOSTNAME>:<PORT>/docs

OpenAPI Specification

Download the OpenAPI specification at:

http://<HOSTNAME>:<PORT>/assets/openapi-specs.json

Available Endpoints

For detailed endpoint documentation, refer to the Swagger UI.

License

This project is licensed under is released under the MIT License.

Changelog

8.2.0 (2025-04-20)

✨ Features

• redis-smq-common: implement ConsoleLogger and improve logging (37122c2)
• redis-smq: enhance logging with detailed debug information (3935682)

🐛 Bug Fixes

• redis-smq: await async queue consumers retrieval in test (0b1f727)

🚀 Chore

• add documentation bug report issue template (502b942)
• use more descriptive labels for docs bug report (4848495)

📝 Documentation

• redis-smq-common: enhance logger documentation and add ConsoleLogger API reference (e6299d7)
• redis-smq-rest-api: update package name reference in README (cf8415d)
• redis-smq: fix typos and enhance API documentation (aabf2fa)
• redis-smq: update configuration examples (906193e)
• update logs documentation link (9561f31)
• update redis-smq references (79bdc4c)
• update redis-smq-common references (d8d9fc3)

✅ Tests

• redis-smq-common: enhance logger tests (98a275b)