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 for providing the WebUI.

📦 Installation

# 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

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)

  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

📈 Changelog

[1.0.2] — 2025-12-19

✨ Added

• 新增文件拖拽上传功能 支持通过拖拽方式快速上传文件，显著提升文件上传效率与整体使用体验。

• Drag-and-drop file upload support Enables quick file uploads via drag-and-drop interactions, significantly improving upload efficiency and overall user experience.

🎨 Improved

• 界面样式优化 对部分页面样式与交互细节进行优化，提升整体视觉一致性与使用流畅度。

• UI and style enhancements Refined selected UI styles and interaction details to improve visual consistency and overall usability.