# knife-demo

**Repository Path**: ngwingbun/knife-demo

## Basic Information

- **Project Name**: knife-demo
- **Description**: knife4j使用示例
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-11-01
- **Last Updated**: 2022-01-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java

## README

# knife-demo


## knife4j 主要模块

- knife4j: 为 Java MVC 框架集成 Swagger 的增强解决方案
- knife4j-admin: 云端 Swagger 接口文档注册管理中心,集成 Gateway 网关对任意微服务文档进行组合集成
- knife4j-extension: Chrome 浏览器的增强 Swagger 接口文档 ui ,快速渲染 Swagger 资源
- knife4j-service: 为 Swagger 服务的一系列接口服务程序
- knife4j-front: knife4j-spring-ui 的纯前端静态版本,用于集成非 Java 语言使用
- swagger-bootstrap-ui: knife4j 的前身,最后发布版本是 1.9.6

## knife4j 使用方式

### 单纯增强前端

#### 老版本使用 swagger-bootstrap-ui

```xml
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/swagger-bootstrap-ui -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>${version}</version>
</dependency>
```

#### 新版本使用 knife4j-spring-ui

```xml
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-ui -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-ui</artifactId>
    <version>${version}</version>
</dependency>
```

### Spring Boot 项目单体架构使用

```xml
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>${version}</version>
</dependency>
```

### Spring Cloud 微服务架构使用

在 Spring Cloud 的微服务架构下,网关才是架构的入口,所以网关才引入 ui ,其他微服务引入微服务的 starter

#### 微服务使用 knife4j-micro-spring-boot-starter

```xml
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-micro-spring-boot-starter -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-micro-spring-boot-starter</artifactId>
    <version>${version}</version>
</dependency>
```

#### 网关使用 knife4j-spring-boot-starter

```xml
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>${version}</version>
</dependency>
```