redis-smq-rest-api

RedisSMQ REST API

[!NOTE] You are viewing the documentation for the "master" branch. These docs describe the latest stable release. For pre-release documentation, see:

• Next (pre-release) README: https://github.com/weyoss/redis-smq/tree/next/packages/redis-smq-rest-api
• Latest release notes/tags: https://github.com/weyoss/redis-smq/releases/latest
• Install stable packages with @latest; pre-release with @next.

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

Installation

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

Don't forget to install a Redis client. Choose either node-redis or ioredis:

npm install @redis/client --save
# or
npm install ioredis --save

Version Compatibility

Always install matching versions of RedisSMQ packages to ensure compatibility. See version compatibility for details.

Documentation

For in-depth guides and API references, see the documentation page:

Related packages

• redis-smq: Core message queue
• redis-smq-common: Shared components/utilities
• redis-smq-web-server: Static hosting + in-process or proxied API
• redis-smq-web-ui: SPA for monitoring and managing RedisSMQ

License

RedisSMQ REST API is released under the MIT License.