Knife4j: A Lightweight Swagger UI Enhancement for Java MVC Frameworks

Knife4j is an enhanced solution for generating Swagger API documentation in Java MVC frameworks, offering a lightweight, feature‑rich UI that can also be used in non‑Java projects.

The project is hosted on GitHub ( https://github.com/xiaoymin/swagger-bootstrap-ui) and Gitee ( https://gitee.com/xiaoym/knife4j).

Key features include a clean left‑menu layout, customizable configuration (API address, description, UI enhancements), powerful functions such as interface sorting, Swagger resource protection, Markdown export, parameter caching, and offline document export in HTML, Markdown, Word, and PDF formats.

Online preview is available at http://knife4j.xiaominfo.com/doc.html, with support for selecting different interfaces, authorization, and viewing Swagger entities and global settings.

Usage examples show how to add the appropriate Maven dependencies for the legacy swagger‑bootstrap‑ui (1.9.6) or the newer knife4j‑spring‑ui, and how to integrate the starter in Spring Boot monolithic applications or Spring Cloud micro‑service architectures, including the micro‑service starter and gateway aggregation.

<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>swagger-bootstrap-ui</artifactId>
  <version>1.9.6</version>
</dependency>

<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>knife4j-spring-ui</artifactId>
  <version>${lastVersion}</version>
</dependency>

<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>knife4j-spring-boot-starter</artifactId>
  <version>${knife4j.version}</version>
</dependency>

<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>knife4j-micro-spring-boot-starter</artifactId>
  <version>${knife4j.version}</version>
</dependency>

The article concludes that Knife4j effectively solves the shortcomings of the default Swagger UI and is a valuable tool for developers.