redis-smq-rest-api 9.0.0-next.16 → 9.0.0-next.17

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [9.0.0-next.17](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.16...v9.0.0-next.17) (2025-11-07)
+
+### 📝 Documentation
+
+- **redis-smq-rest-api:** restructure README, move details to separate files ([2a5e5d9](https://github.com/weyoss/redis-smq/commit/2a5e5d9a4644e9d1ce490262e7682a83e9dc0e00))
+- standardize documentation links to use relative paths ([fc7c474](https://github.com/weyoss/redis-smq/commit/fc7c474bffbd2160fb9bb8727cec4bbdc5a23dc8))
+
 ## [9.0.0-next.16](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.15...v9.0.0-next.16) (2025-11-05)
 
 ### ♻️ Code Refactoring

package/README.md

@@ -39,162 +39,18 @@ npm install ioredis --save
 
 ## Version Compatibility
 
-⚠️ Important: Always install matching versions of RedisSMQ packages to ensure compatibility.
+Always install matching versions of RedisSMQ packages to ensure compatibility. See [version compatibility](/packages/redis-smq/docs/version-compatibility.md) for details.
 
-```bash
-npm install redis-smq@x.x.x redis-smq-rest-api@x.x.x redis-smq-common@x.x.x
-```
-
-See [version compatibility](/packages/redis-smq/docs/version-compatibility.md) for details.
-
-## Configuration
-
-The REST API configuration extends the base [RedisSMQ configuration](/packages/redis-smq/docs/configuration.md) with additional API server settings.
-
-### Configuration Options
-
-```typescript
-export interface IRedisSMQHttpApiConfig extends IRedisSMQConfig {
-  apiServer?: {
-    // Port to run the REST API on. Default: 7210
-    port?: number;
-
-    // Base path to mount the REST API and docs under. Default: '/'
-    basePath?: string;
-  };
-}
-```
-
-### Configuration Examples
-
-```typescript
-import { ERedisConfigClient, EConsoleLoggerLevel } from 'redis-smq-common';
-
-const config = {
-  apiServer: {
-    port: 7210,
-    basePath: '/', // API at '/api', Swagger at '/swagger'
-  },
-  redis: {
-    client: ERedisConfigClient.IOREDIS,
-    options: {
-      host: '127.0.0.1',
-      port: 6379,
-      db: 0,
-    },
-  },
-  logger: {
-    enabled: true,
-    options: {
-      logLevel: EConsoleLoggerLevel.INFO, // or 'INFO'
-    },
-  },
-};
-```
-
-## Programmatic Usage
-
-The RedisSMQRestApi class can be used as a standalone server or embedded as middleware in an existing Express application.
+## Documentation
 
-### Standalone Server
-
-This mode starts an HTTP server that listens on the configured port.
-
-```typescript
-import { RedisSMQRestApi } from 'redis-smq-rest-api';
-import { ERedisConfigClient } from 'redis-smq-common';
-
-const api = new RedisSMQRestApi({
-  apiServer: { port: 7210 },
-  redis: {
-    client: ERedisConfigClient.IOREDIS,
-    options: { host: '127.0.0.1', port: 6379, db: 0 },
-  },
-});
-
-await api.run();
-```
-
-### Embedded Middleware
-
-To integrate into an existing Express app, instantiate RedisSMQRestApi with false as the second argument to prevent it
-from starting its own listener. Then, use getApplication() to get the middleware.
-
-```javascript
-import express from 'express';
-import { RedisSMQRestApi } from 'redis-smq-rest-api';
-import { ERedisConfigClient } from 'redis-smq-common';
-
-const app = express();
-const api = new RedisSMQRestApi(
-  {
-    apiServer: { basePath: '/api' }, // port is ignored
-    redis: { client: ERedisConfigClient.IOREDIS },
-  },
-  false, // <-- disable listener
-);
-
-const restApiMiddleware = await api.getApplication();
-app.use(restApiMiddleware);
-
-app.listen(3000, () =>
-  console.log('Host app listening on http://localhost:3000'),
-);
-```
-
-## Usage from CLI
-
-The REST API server can be started directly from your terminal after installation.
-
-```shell
-npx redis-smq-rest-api
-```
-
-### CLI Options
-
-You can override the default configuration using the following command-line arguments:
-
-```shell
--p, --port <number>                 Port to run the REST API on (default: "7210")
--b, --base-path <string>            Base path to mount the REST API under (default: "/")
--c, --redis-client <ioredis|redis>  Redis client. Valid options are: ioredis, redis. (default: "ioredis")
--r, --redis-host <string>           Redis server host (default: "127.0.0.1")
--o, --redis-port <number>           Redis server port (default: "6379")
--d, --redis-db <number>             Redis database number (default: "0")
--e, --enable-log <0|1>              Enable console logging: 0 (disabled), 1 (enabled) (default: "0")
--v, --log-level <0|1|2|3>           Log level. Numbers: 0=DEBUG, 1=INFO, 2=WARN, 3=ERROR (default: "1")
--h, --help                          Display help for command
-```
-
-### CLI Examples
-
-Starting the server on a specific port and connecting to a different Redis instance:
-
-```shell
-npx redis-smq-rest-api --port 8000 --redis-host 10.0.0.5 --redis-port 6380
-```
-
-## API Documentation
-
-### Swagger UI
-
-Access the interactive API documentation at:
-
-```text
-http://<HOSTNAME>:<PORT>/swagger
-```
-
-### OpenAPI Specification
-
-Download the OpenAPI specification at:
-
-```text
-http://<HOSTNAME>:<PORT>/swagger/assets/openapi-specs.json
-```
+For in-depth guides and API references, see [the documentation page](docs/README.md):
 
-## Available Endpoints
+## Related packages
 
-For detailed endpoint documentation, refer to the Swagger UI.
+- [redis-smq](../redis-smq/README.md): Core message queue
+- [redis-smq-common](../redis-smq-common/README.md): Shared components/utilities
+- [redis-smq-web-server](../redis-smq-web-server/README.md): Static hosting + in-process or proxied API
+- [redis-smq-web-ui](../redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq-rest-api",
-  "version": "9.0.0-next.16",
+  "version": "9.0.0-next.17",
   "description": "REST API for RedisSMQ: OpenAPI 3 schema and Swagger UI for managing queues, messages, and consumers.",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",
@@ -68,8 +68,8 @@
   "peerDependencies": {
     "@redis/client": "^5",
     "ioredis": "^5",
-    "redis-smq": "^9.0.0-next.16",
-    "redis-smq-common": "^9.0.0-next.16"
+    "redis-smq": "^9.0.0-next.17",
+    "redis-smq-common": "^9.0.0-next.17"
   },
   "peerDependenciesMeta": {
     "@redis/client": {