xypriss-swagger 1.0.32 → 1.0.36
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/README.md +14 -11
- package/package.json +2 -2
- package/xypriss.plugin.xsig +5 -5
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# XyPriss Swagger Plugin
|
|
2
2
|
|
|
3
|
-
The **XyPriss Swagger Plugin** is a high-performance auto-documentation tool for the XyPriss ecosystem. It automatically generates OpenAPI 3.0 specifications by introspecting the XyPriss route registry and serves a beautiful Swagger UI through an isolated auxiliary server.
|
|
3
|
+
The **[XyPriss Swagger Plugin](https://github.com/Nehonix-Team/XyPriss/blob/master/mods/swagger)** is a high-performance auto-documentation tool for the XyPriss ecosystem. It automatically generates OpenAPI 3.0 specifications by introspecting the XyPriss route registry and serves a beautiful Swagger UI through an isolated auxiliary server.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
@@ -15,7 +15,7 @@ The **XyPriss Swagger Plugin** is a high-performance auto-documentation tool for
|
|
|
15
15
|
Install the plugin via XFPM:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
xfpm add xypriss-swagger
|
|
18
|
+
xfpm add xypriss-swagger --verify
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## Usage
|
|
@@ -28,16 +28,19 @@ In your main XyPriss application, import and register the `SwaggerPlugin`:
|
|
|
28
28
|
import { SwaggerPlugin } from "xypriss-swagger";
|
|
29
29
|
import { XyPrissServer } from "xypriss";
|
|
30
30
|
|
|
31
|
-
const server =
|
|
31
|
+
const server = createServer({
|
|
32
|
+
plugins: {
|
|
33
|
+
register: [
|
|
34
|
+
SwaggerPlugin({
|
|
35
|
+
port: 7070, // Port for the documentation server
|
|
36
|
+
path: "/docs", // Path to access the Swagger UI
|
|
37
|
+
title: "My API", // Documentation title
|
|
38
|
+
version: "1.0.0", // API Version
|
|
39
|
+
}),
|
|
40
|
+
],
|
|
41
|
+
},
|
|
42
|
+
});
|
|
32
43
|
|
|
33
|
-
server.use(
|
|
34
|
-
SwaggerPlugin({
|
|
35
|
-
port: 7070, // Port for the documentation server
|
|
36
|
-
path: "/docs", // Path to access the Swagger UI
|
|
37
|
-
title: "My API", // Documentation title
|
|
38
|
-
version: "1.0.0", // API Version
|
|
39
|
-
}),
|
|
40
|
-
);
|
|
41
44
|
|
|
42
45
|
server.start();
|
|
43
46
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "xypriss-swagger",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.36",
|
|
4
4
|
"description": "Auto-documentation plugin for XyPriss Router V2",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
@@ -45,4 +45,4 @@
|
|
|
45
45
|
"typescript": "^5.0.0"
|
|
46
46
|
},
|
|
47
47
|
"peerDependencies": {}
|
|
48
|
-
}
|
|
48
|
+
}
|
package/xypriss.plugin.xsig
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
--- XYPRISS SIGNATURE (G3) ---
|
|
2
|
-
Manifest: xypriss-swagger@1.0.
|
|
3
|
-
Min-Engine: 1.0.
|
|
4
|
-
Fingerprint: sha256:
|
|
2
|
+
Manifest: xypriss-swagger@1.0.36
|
|
3
|
+
Min-Engine: 1.0.29
|
|
4
|
+
Fingerprint: sha256:8eac1f742c803956f15dd5c25b62f6ae4ef6831cd4f1282cd307527c0a6a834d
|
|
5
5
|
Identity: ed25519:a58b17a3e46302dd3ae5538bc9b8b991c57f4c5fe2e7d8ac41803de818d947f4
|
|
6
|
-
Expires: 2027-04-
|
|
6
|
+
Expires: 2027-04-22T11:51:22Z
|
|
7
7
|
Revision: sha256:none
|
|
8
8
|
--- BEGIN CRYPTOGRAPHIC PROOF ---
|
|
9
|
-
base64:
|
|
9
|
+
base64:QoQVvBkDNRa08k5tnK9VQxq0F9HQYM8E81Mzzvx1ij9iSEmxipKRQKIH8svQzLes/XOOSmKaMOc3I+QYrmEhBA==
|
|
10
10
|
--- END XYPRISS SIGNATURE ---
|