redis-smq-rest-api 9.0.0-next.0 → 9.0.0-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +30 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [9.0.0-next.1](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.0...v9.0.0-next.1) (2025-09-06)
|
|
7
|
+
|
|
8
|
+
### 📝 Documentation
|
|
9
|
+
|
|
10
|
+
- **redis-smq-rest-api:** add CLI usage documentation and examples ([c51cf48](https://github.com/weyoss/redis-smq/commit/c51cf4860ba556ce72b42472289f1bc8b69a3647))
|
|
11
|
+
|
|
6
12
|
## [9.0.0-next.0](https://github.com/weyoss/redis-smq/compare/v8.3.1...v9.0.0-next.0) (2025-09-06)
|
|
7
13
|
|
|
8
14
|
### ⚠ BREAKING CHANGES
|
package/README.md
CHANGED
|
@@ -81,7 +81,7 @@ const basicConfig: IRedisSMQHttpApiConfig = {
|
|
|
81
81
|
};
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
-
## Usage
|
|
84
|
+
## Programmatic Usage
|
|
85
85
|
|
|
86
86
|
```typescript
|
|
87
87
|
import { RedisSmqRestApi } from 'redis-smq-rest-api';
|
|
@@ -104,6 +104,35 @@ const apiServer = new RedisSmqRestApi(config);
|
|
|
104
104
|
apiServer.run();
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
+
## Usage from CLI
|
|
108
|
+
|
|
109
|
+
The REST API server can be started directly from your terminal after installation.
|
|
110
|
+
|
|
111
|
+
```shell
|
|
112
|
+
npx redis-smq-rest-api
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### CLI Options
|
|
116
|
+
|
|
117
|
+
You can override the default configuration using the following command-line arguments:
|
|
118
|
+
|
|
119
|
+
```shell
|
|
120
|
+
-p, --port <port> Port to run the API server on (default: "7210")
|
|
121
|
+
-B, --base-path <basePath> Base public path for the Swagger UI (default: "/")
|
|
122
|
+
-H, --redis-host <redisHost> Redis server host (default: "127.0.0.1")
|
|
123
|
+
-P, --redis-port <redisPort> Redis server port (default: "6379")
|
|
124
|
+
-D, --redis-db <redisDB> Redis database number (default: "0")
|
|
125
|
+
-h, --help display help for command
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### CLI Examples
|
|
129
|
+
|
|
130
|
+
Starting the server on a specific port and connecting to a different Redis instance:
|
|
131
|
+
|
|
132
|
+
```shell
|
|
133
|
+
npx redis-smq-rest-api --port 8000 --redis-host 10.0.0.5 --redis-port 6380
|
|
134
|
+
```
|
|
135
|
+
|
|
107
136
|
## API Documentation
|
|
108
137
|
|
|
109
138
|
### Swagger UI
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "redis-smq-rest-api",
|
|
3
|
-
"version": "9.0.0-next.
|
|
3
|
+
"version": "9.0.0-next.1",
|
|
4
4
|
"description": "REST API for RedisSMQ: OpenAPI 3 schema and Swagger UI for managing queues, messages, and consumers.",
|
|
5
5
|
"author": "Weyoss <weyoss@protonmail.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -66,8 +66,8 @@
|
|
|
66
66
|
"uuid": "11.1.0"
|
|
67
67
|
},
|
|
68
68
|
"peerDependencies": {
|
|
69
|
-
"redis-smq": "^9.0.0-next.
|
|
70
|
-
"redis-smq-common": "^9.0.0-next.
|
|
69
|
+
"redis-smq": "^9.0.0-next.1",
|
|
70
|
+
"redis-smq-common": "^9.0.0-next.1"
|
|
71
71
|
},
|
|
72
72
|
"devDependencies": {
|
|
73
73
|
"@types/json-schema": "7.0.15",
|