nestjs-knife4j-plus 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 jkhuangfu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+## Description
+
+The provided code sets up Knife4j for enhancing Swagger/OpenAPI documentation in a NestJS application, supporting both Express and Fastify HTTP adapters. Thanks to [@xiaoymin](https://github.com/xiaoymin) for providing the WebUI.
+
+[![NPM version](https://img.shields.io/npm/v/nestjs-knife4j-plus?style=for-the-badge)](https://www.npmjs.com/package/nestjs-knife4j-plus) [![License: MIT](https://img.shields.io/badge/License-MIT-green?style=for-the-badge)](LICENSE) [![GitHub issues](https://img.shields.io/github/issues/jkhuangfu/nestjs-knife4j-plus?style=for-the-badge)](https://github.com/jkhuangfu/nestjs-knife4j-plus/issues)
+
+## 📦 Installation
+
+```bash
+# Install the package
+npm install nestjs-knife4j-plus @nestjs/swagger
+
+# For Fastify adapter, also install:
+npm install @fastify/static
+```
+
+## 🔄 Compatibility Matrix
+
+| @fastify/static version | Fastify version |
+| ----------------------- | --------------- |
+| `^8.x`                  | `^5.x`          |
+| `^7.x`                  | `^4.x`          |
+| `^5.x`                  | `^3.x`          |
+| `^2.x`                  | `^2.x`          |
+| `^1.x`                  | `^1.x`          |
+
+## 🚀 Usage
+
+```typescript
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'
+import { knife4jSetup } from 'nestjs-knife4j-plus'
+
+// To use this with Fastify, first install @fastify/static. Please ensure version compatibility.
+
+async function bootstrap() {
+  const options = new DocumentBuilder()
+    .setTitle('Cats example')
+    .setDescription('The cats API description')
+    .setVersion('1.0')
+    .addTag('cats')
+    .build()
+  const document = SwaggerModule.createDocument(app, options)
+  SwaggerModule.setup('api', app, document)
+
+  // if you want to use express adapter, you can use the following code
+  knife4jSetup(app, [
+    {
+      name: '2.0 version',
+      url: `/api-json`,
+    },
+  ])
+
+  await app.listen(3000)
+}
+```
+
+then you can browse on [http://127.0.0.1:3000/doc.html](http://127.0.0.1:3000/doc.html)
+
+## 📈 Changelog

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+import type { INestApplication } from '@nestjs/common';
+/**
+ * 服务配置接口
+ */
+export interface Service {
+    /** 服务名称 */
+    name: string;
+    /**
+     * OpenAPI JSON 地址，通常为 Swagger 配置的路径 + '-json'
+     * @example 如果 Swagger 访问路径为 '/api'，则 OpenAPI JSON 地址为 '/api-json'
+     */
+    url: string;
+}
+/**
+ * 配置knife4j
+ *
+ * @param app - NestFactory.create() 创建的应用实例 (支持 Express / Fastify)
+ * @param services - Knife4j 多服务配置数组，每项需实现 {@link Service} 接口
+ *
+ * @example
+ * ```typescript
+ * // in main.ts
+ *
+ * import { SwaggerModule, DocumentBuilder } from "@nestjs/swagger";
+ * import { knife4jSetup, type Service } from 'nestjs-knife4j-plus';
+ * // To use this with Fastify, first install `@fastify/static`. Please ensure version compatibility.
+ *
+ * async function bootstrap() {
+ *   const app = await NestFactory.create(AppModule);
+ *   const config = new DocumentBuilder()
+ *     .setTitle("API")
+ *     .setDescription("API接口文档")
+ *     .build();
+ *   const document = SwaggerModule.createDocument(app, config);
+ *   SwaggerModule.setup("api", app, document);
+ *   await knife4jSetup(app, [
+ *     {
+ *       name: '用户服务',
+ *       url: '/api-json'
+ *     }
+ *   ]);
+ *   await app.listen(3000);
+ * }
+ * bootstrap();
+ * ```
+ */
+export declare function knife4jSetup(app: INestApplication, services: Service[]): Promise<void>;

package/dist/index.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.knife4jSetup = knife4jSetup;
+const node_path_1 = require("node:path");
+async function knife4jSetup(app, services) {
+    const httpAdapter = app.getHttpAdapter().getType();
+    const instance = app.getHttpAdapter().getInstance();
+    if (!['express', 'fastify'].includes(httpAdapter)) {
+        throw new Error('http adapter only supported express and fastify');
+    }
+    if (httpAdapter === 'express') {
+        try {
+            const expressStatic = await Promise.resolve().then(() => require('express')).then((mod) => mod.static);
+            app.use('/', expressStatic((0, node_path_1.resolve)(__dirname, '../ui/')));
+            app.use('/services.json', (_, res) => {
+                res.send(services);
+            });
+        }
+        catch (error) {
+            throw new Error('Express is not installed');
+        }
+        return;
+    }
+    try {
+        const fastifyStatic = await Promise.resolve().then(() => require('@fastify/static')).then((mod) => mod.default);
+        instance.register(fastifyStatic, {
+            root: (0, node_path_1.join)(__dirname, '../ui'),
+            prefix: '/',
+            decorateReply: false,
+        });
+        instance.get('/services.json', (_, repl) => {
+            repl.send(services);
+        });
+    }
+    catch (error) {
+        throw new Error('@fastify/static is not installed please install it first , run `npm install @fastify/static` or `yarn add @fastify/static`');
+    }
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "nestjs-knife4j-plus",
+  "version": "1.0.0",
+  "description": "NestJS Knife4j integration for enhanced Swagger/OpenAPI documentation with support for both Express and Fastify adapters. Provides a powerful API documentation UI based on Knife4j.",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "keywords": [
+    "nestjs",
+    "knife4j",
+    "swagger",
+    "openapi"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jkhuangfu/nestjs-knife4j-plus.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build-js": "tsc -p tsconfig.js.json",
+    "build-dts": "tsc -p tsconfig.dts.json",
+    "build": "npm run build-js && npm run build-dts"
+  },
+  "files": [
+    "/ui",
+    "/dist"
+  ],
+  "author": "jkhuangfu",
+  "devDependencies": {
+    "@types/node": "^20.14.12",
+    "typescript": "^5.5.4"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "*",
+    "@fastify/static": "*",
+    "express": "*",
+    "fastify": "*"
+  },
+  "peerDependenciesMeta": {
+    "@fastify/static": {
+      "optional": true
+    },
+    "fastify": {
+      "optional": true
+    }
+  }
+}