redis-smq-rest-api
v9.0.5
Published
REST API for RedisSMQ: OpenAPI 3 schema and Swagger UI for managing queues, messages, and consumers.
Maintainers
Readme
RedisSMQ REST API
IS_NEXT_NOTE
NPM_BADGE CODECOV_BADGE
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__TAG_SUFFIX__ redis-smq-common__TAG_SUFFIX__ redis-smq-rest-api__TAG_SUFFIX__ --saveDon't forget to install a Redis client. Choose either node-redis or ioredis:
npm install @redis/client --save
# or
npm install ioredis --saveVersion 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.
